Clarify APIList API keys
Returns API keys as a JSON:API list with `links` and `meta`, in one page. Requires a user access token. Admins see every personal and workspace key, and members see only their own personal keys. Secrets are never returned.
Authorization
bearer User access token authentication for endpoints that act across workspaces. Send a WorkOS access token in the Authorization header as: Bearer <token>.
In: header
Path Parameters
The workspace slug — the {slug} segment of your Clarify workspace URL.
Response Body
application/json
curl -X GET "https://example.com/workspaces/string/api-keys"{ "links": { "next": null, "prev": null }, "meta": { "total_records": 1, "total_pages": 1, "offset": 0, "limit": 500 }, "data": [ { "type": "api-key", "id": "4a7c2e9f-6b1d-4e3a-8f5c-0d2b4e6a8c19", "attributes": { "_id": "4a7c2e9f-6b1d-4e3a-8f5c-0d2b4e6a8c19", "name": "Acme CRM sync", "key_prefix": "3f9a1c7e", "scopes": [], "actor": { "type": "user", "id": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81" }, "on_behalf_of": null, "hidden": false, "_created_by": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81", "expires_at": null, "_created_at": "2026-01-15T09:30:00.000Z", "_updated_at": "2026-02-01T17:45:00.000Z", "last_used_at": "2026-02-01T17:45:00.000Z" } } ]}Delete an API key
Revokes an API key so it stops authenticating requests. Requires a user access token. Admins can delete any key, and members only their own personal keys.
List campaign recipients
Returns the people enrolled in a campaign as an offset-paginated JSON:API collection, each with their per-recipient engagement — whether they opened, clicked, replied, or unsubscribed, and when each last happened. Filter by engagement with `filter[event]` (for example `filter[event]=clicked` to build a retargeting audience), by delivery state with `filter[status]`, or by name/email with `filter[q]`. Recipients are collapsed to one row per person, preferring their active run.