GET /v1/partners
GET /v1/partners
| Scope | Idempotency-Key | Operation ID |
|---|---|---|
partners.read | — | listPartners |
Delivery partners available to this tenant.
A filtered projection, never the registry: only partners that are ACTIVE, not blocked for
fees or on compliance hold, KYC-approved or within an active trial and not stopped by an
emergency control, and that the tenant's partner policy admits (the shared
network, or only its linked partners; a tenant locked to one partner sees that partner
alone). preferred and dispatch_locked describe this tenant's own link; nothing about
another tenant's relationships is ever returned. Ordered by public ID; cursor-paginated.
Shares the geography endpoint class for rate limits.
Request
Signed with your API credential: see Authentication.
| Parameter | In | Required | Description |
|---|---|---|---|
cursor | query | No | Opaque cursor from a previous page's next_cursor. |
limit | query | No | 1–100. |
Responses
200
One page.
| Field | Type | Required | Description |
|---|---|---|---|
items | array of object | Yes | |
items[].public_id | string | Yes | Pattern ^prt_[a-z0-9][a-z0-9_]{1,62}$. |
items[].name | string | Yes | |
items[].preferred | boolean | Yes | This tenant's preferred partner |
items[].dispatch_locked | boolean | Yes | This tenant's dispatch is locked to this partner |
items[].coverage | array of object | Yes | |
items[].coverage[].gateway | string | Yes | Pattern ^[A-Z0-9][A-Z0-9_]{0,39}$. |
items[].coverage[].zone | string or null | No | A zone of that gateway; absent or null for the whole gateway. |
items[].vehicle_types | array of string | Yes | |
next_cursor | string or null | Yes |
400
Structural validation failed or an Idempotency-Key is missing.
The error envelope: code, message, detail, request_id.
401
Unknown, revoked or wrong-environment credential, bad signature, or expired session.
The error envelope: code, message, detail, request_id.
403
Tenant access denied (existence is not disclosed), insufficient scope, MFA/step-up required, partner blocked or module disabled.
The error envelope: code, message, detail, request_id.
429
Rate limit reached; honour Retry-After.
The error envelope: code, message, detail, request_id.
500
Unexpected failure. Only code and request_id are returned.
The error envelope: code, message, detail, request_id.
503
Pricing/routing unavailable, request timeout, retryable contention, or an operator must act first (ACCOUNTING_PERIOD_UNAVAILABLE, outcome REQUIRES_ADMIN), or the payment provider cannot start a payment (PAYMENT_PROVIDER_UNAVAILABLE, outcome REQUIRES_PAYMENT; nothing charged).
The error envelope: code, message, detail, request_id.