Skip to content

The same visibility rules as in the panel apply: fully expired services are hidden by default. Use state to filter by the state shown in the panel.

An unknown parameter or an invalid value returns 400 invalid_request; details.field tells you which parameter.

The list endpoint has no statistics. They would need a backend call for every service, so the endpoint is kept light on purpose; get usage from the Service details endpoint.

Authorization

Authorizationstringrequired

Sent as Bearer <token>. This endpoint needs the orders:read (Service information) scope; a token without it gets 403.

Query parameters

typeenum<string>

Filters by service type.

statusstring

Filters by raw status.

stateenum<string>

Filters by the state shown in the panel. With expired, fully expired services are listed too. The values are on the Service states page.

limitintegerdefault: 25

Records per page: 1-100. 0, a negative or a non-integer value returns 400; values above 100 are capped at 100 (meta.limit shows the value applied).

offsetintegerdefault: 0

Number of records to skip.

include_expiredboolean

true also lists fully expired and cancelled services. It turns on automatically when you pass status=expired or cancelled.

Response

200
application/json
dataobject[]
metaobject