API conventions

Requests and Responses

Read each endpoint panel for its exact response shape instead of assuming every SparkGlim API returns one generic envelope.

Validation

Required, optional, and nullable fields follow the server validation schema documented per endpoint.

Where a route returns pagination metadata, preserve it and request subsequent pages explicitly.

Payments and webhook-driven operations may remain pending until the authoritative provider event is processed.