List connections
With an sk_ API key: every connection across the tenant's applications (optional ?app_id= and ?status= filters). With a widget JWT or a delegated agent token: the calling application's connections (app_id is ignored — the scope is fixed to that application).
The response is paginated and always bounded. limit defaults to 500 and is clamped to 1000; next_cursor is present only when more rows remain. To read every connection, follow next_cursor until it is absent. Counting rows client-side is not required — see GET /connections:count.
A status outside the enum is rejected with 400 (it used to reach the database and surface as a 500).
Long-lived tenant API key (sk_live_… / sk_test_…), stored hashed. Scoped to the owning application's tenant.
In: header
Query Parameters
Value in
- "pending"
- "propagating"
- "live"
- "failed"
Rows per page. Defaults to 500; values above 1000 are clamped to 1000.
1 <= value <= 1000500Opaque keyset cursor taken verbatim from a previous response's next_cursor. Omit for the first page.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/connections"{ "connections": [ { "id": "string", "application_id": "string", "domain": "string", "host": "string", "provider_id": "string", "setup_type": "automatic", "status": "pending", "managed": true, "created_at": "2019-08-24T14:15:22Z", "last_checked_at": "2019-08-24T14:15:22Z", "www_redirect": true, "override_spf": true, "validate_dmarc": true, "validate_caa": true, "monitor": true, "batch_id": "string", "end_user_ref": "string", "secure_root_domain": true, "redirect_to": "http://example.com", "power_root_path_access": [ "string" ], "error_code": "string", "error_message": "string" } ], "count": 0, "next_cursor": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}