Catalogue
List sites
AuthorizationBearer <token>
Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.
In: header
Query Parameters
cursor?string
Opaque pagination cursor from meta.cursor.next of the previous page. Do not construct or parse it.
limit?integer
Page size. Values above the maximum are clamped.
Range
1 <= value <= 100Default
25status?string
Filter by site status.
Value in
- "active"
- "coming_soon"
- "closed"
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/sites"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "site", "name": "string", "slug": "string", "code": "string", "status": "active", "timezone": "Europe/London", "address_line1": "string", "address_line2": "string", "city": "string", "region": "string", "postcode": "string", "country_code": "st", "latitude": 0, "longitude": 0, "phone": "string", "email": "user@example.com", "default_notice_period_days": 14, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "meta": { "limit": 0, "cursor": { "next": "string", "has_more": true } }}{ "error": { "code": "unauthorized", "message": "Missing or invalid credential." }}{ "error": { "code": "insufficient_scope", "message": "The credential lacks a scope required by this endpoint." }}{ "error": { "code": "rate_limited", "message": "Rate limit exceeded. Retry after 7s." }}{ "error": { "code": "validation_error", "message": "string", "details": [ { "field": "string", "issue": "string" } ] }}