Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Public API access token issued by /public/v1/oauth/token. Example: Authorization: Bearer fspt_.... Each resource request rechecks the token company's current provider access. Disabling access blocks existing tokens with 403 auth.provider_unavailable.

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:50
Required range: 1 <= x <= 200
status
enum<string>[]

Optional comma-separated statuses. Omit this filter to return active, expired, and empty credit allocations.

Available options:
active,
expired,
empty
source
enum<string>[]

Optional comma-separated credit sources.

Available options:
pack,
membership,
manual
clientId
string
Example:

"66f7b8b1e13c8d25f4d3d90a"

startDate
string<date>

Optional inclusive expiry-date range start in YYYY-MM-DD.

Example:

"2026-08-01"

endDate
string<date>

Optional inclusive expiry-date range end in YYYY-MM-DD.

Example:

"2026-08-31"

balanceType
enum<string>
Available options:
positive,
negative
sort
enum<string>
Available options:
remaining_asc,
remaining_desc

Response

Credits fetched

data
object
required
meta
object
required