Skip to main content
GET
List Services
Returns a paginated list of services that belong to the authenticated broker. The full endpoint is GET /api/v1/services. The request does not have a body.

Filtering and order

The API applies all specified filters before it applies offset and limit. Without modified_since, the API sorts services by created_date in descending order. With modified_since, the API sorts by last_modified in ascending order. It then sorts equal timestamps by service_number in ascending order. The modified_since boundary is inclusive. A service can occur in two polling responses when its last_modified value is equal to the boundary. Use service_number as the public record identifier when processing repeated results. The pagination.page value is floor(offset / limit) + 1. For predictable page numbers, use an offset that is a multiple of limit.

Endpoint errors

For authentication, permissions, rate limits, and safe retries, see Errors and Retries.

Authorizations

Authorization
string
header
required

Send the API key in the Authorization bearer header. Production keys begin with sk_live_.

Query Parameters

limit
integer
default:20

Maximum rows returned; runtime clamps the value to 1–100.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of matching rows to skip; runtime clamps negative values to zero.

Required range: x >= 0
status
enum<string>
Available options:
active,
pending,
suspended,
cancelled

Case-insensitive customer name/email search, or exact numeric service number.

modified_since
string<date-time>

Inclusive full ISO 8601 timestamp with timezone.

include_credentials
boolean
default:false

Set to true to include cached VPS credentials; requires admin:full.

Response

Paginated service list.

success
boolean
required
pagination
object
required
data
object[]
required
message
string
Last modified on September 8, 2026