Reference
List API keys
GET /v1/api-keys. API keys and agent keys, with each agent key's live spend meter.
GET /v1/api-keys
API keys and agent keys, with each agent key's live spend meter. Secrets are never shown again.
| Property | Value |
|---|---|
| Endpoint | GET https://mydatahub.emailmovers.com/v1/api-keys |
| Operation id | listApiKeys |
| Cost | Free (0 credits) |
| Access | An API key or an OAuth 2.1 token with the scope admin. |
| Tag | Keys |
Request
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer (1 to 100) | no | Items per page, 1 to 100. Default 25. |
cursor | query | string | no | An opaque cursor from next_cursor. Pass it back unchanged. |
MyDataHub-Version | header | string | no | The dated API version, pinned per key when left out. Non-breaking changes ship as new dates; the path major changes only for breaking changes, with a 12 month deprecation window. |
Example request
curl "https://mydatahub.emailmovers.com/v1/api-keys" \
-H "Authorization: Bearer $MYDATAHUB_API_KEY"Responses
200: A page of keys.
Headers: RateLimit, RateLimit-Policy.
| Member | Type | Always present | Description |
|---|---|---|---|
data | array of StandardApiKey or AgentKey | yes | |
has_more | boolean | yes | Whether another page follows. |
next_cursor | string or null | yes | Pass as cursor to fetch the next page; null on the last page. |
Example response
{
"data": [
{
"id": "key_01JB3Z9R6T1Y5W8ZAK8Q2V7XN3",
"kind": "agent",
"label": "SDR agent",
"mode": "live",
"prefix": "mdh_live_7Kq2",
"scopes": [
"counts:read",
"quotes:read",
"orders:write",
"orders:read",
"records:read",
"pushes:write"
],
"ip_allowlist": [],
"created_at": "2026-09-20T09:00:00Z",
"created_by": "usr_01JA0Q3V7XN3M9R6T1Y5W8ZAK8",
"last_used_at": "2026-09-26T02:00:00Z",
"expires_at": "2027-03-31T00:00:00Z",
"revoked_at": null,
"allowed_tools": [
"count_audience",
"quote_order",
"create_order",
"fetch_order_records",
"push_to_crm"
],
"allowed_connection_ids": ["conn_01JB3Y2X6Y7Z8A1B2C3D4E5F6G"],
"monthly_budget_credits": 1000,
"per_order_max_credits": 500,
"budget": {
"monthly_credits": 1000,
"spent": 400,
"remaining": 600,
"resets_at": "2026-10-01T00:00:00Z"
},
"webhook_url": "https://agent.example.com/mydatahub/events",
"disclosure": "account"
}
],
"has_more": false,
"next_cursor": null
}Errors
Every error is a problem object with a code and a next_step. Every response carries the RateLimit and RateLimit-Policy headers; see Rate limits.
| Status | Problem codes | When |
|---|---|---|
| 400 | invalid-request, idempotency-key-required, unsupported-version | The request could not be read, or an Idempotency-Key is missing. |
| 401 | authentication-required, account-required | Sign in (OAuth) or send an API key (authentication-required), or create a free account for what the anonymous tier does not cover (account-required). |
| 403 | insufficient-scope, confirmation-required, business-details-required, licence-acceptance-required, dpa-acceptance-required, agent-budget-exceeded | The token lacks a scope (insufficient-scope, with required_scope and a WWW-Authenticate step-up challenge); no person confirmed the spend and no agent key covers it (confirmation-required, with an approval_url); an agent key's per-order cap or monthly budget does not cover it (agent-budget-exceeded); an account made by self-serve sign-up has not yet confirmed its business name and that it is a UK business, which its first order needs (business-details-required); the order needs the Data Licence and Sharing Agreement accepted at the version in force (licence-acceptance-required); or a suppression upload comes before the organisation has accepted the Article 28 data processing agreement in force (dpa-acceptance-required). Nothing is charged. |
| 422 | validation-failed, quote-required, dataset-unavailable | The request is not valid. errors lists every problem with a JSON pointer and did_you_mean. |
| 429 | rate-limited | Too many requests. Wait for Retry-After. |
| Any other failure | internal-error, service-unavailable, tps-screen-expired | Something failed on our side (500 internal-error) or the service is briefly unavailable (503 service-unavailable, with Retry-After). Nothing was charged; retry with the same Idempotency-Key. A count, sample, quote or order with telephone in play is also refused with 503 tps-screen-expired, with no Retry-After, while the dataset version's TPS and CTPS screen is more than 28 days old. |