REST reference

65 operations of the MyDataHub REST API, generated from the OpenAPI 3.1 document.

Generated from the contractsView as Markdown

65 operations in 15 groups, all under https://mydatahub.emailmovers.com/v1. Each page is generated from the OpenAPI 3.1 document, so a member, scope or cost on a page is the one the API is tested against.

Send MyDataHub-Version with a date to pin behaviour, and Idempotency-Key on any request that creates or charges. See Versions and reproducibility and Quotes and orders. Lists return {data, has_more, next_cursor}.

Catalogue

Free and public: plans, datasets, filter fields and values, field sets, title expansion, location resolution and compiling a brief.

Operation	Endpoint	Cost
Get plans and prices	`GET /v1/plans`	Free (0 credits)
List datasets	`GET /v1/datasets`	Free (0 credits)
Get a dataset version changelog	`GET /v1/datasets/{dataset}/versions/{version}`	Free (0 credits)
List filter fields	`GET /v1/catalogue/filters`	Free (0 credits)
Search filter values	`GET /v1/catalogue/filters/{dimension}/values`	Free (0 credits)
List field sets	`GET /v1/field-sets`	Free (0 credits)
Expand job titles	`POST /v1/job-titles/expand`	Free (0 credits)
Resolve a location	`POST /v1/locations/resolve`	Free (0 credits)
Compile a brief	`POST /v1/audiences/compile`	Free (0 credits)

Counts

Free and public: counts with breakdowns, and masked samples (previews).

Operation	Endpoint	Cost
Count an audience	`POST /v1/counts`	Free (0 credits)
Get a count	`GET /v1/counts/{id}`	Free (0 credits)
Preview sample records	`POST /v1/previews`	Free (0 credits)

Samples

A sample of a counted audience, sent only after a person confirms a work email address, and downloaded once.

Operation	Endpoint	Cost
Ask for a sample of a count	`POST /v1/sample-requests`	Free (0 credits)
Send the confirmation link for a sample	`POST /v1/sample-requests/{id}/email`	Free (0 credits)
Get a sample request	`GET /v1/sample-requests/{id}`	Free (0 credits)
Confirm a sample and get its download link	`POST /v1/sample-downloads`	Free (0 credits)

Audiences

Saved audiences shared across the organisation.

Operation	Endpoint	Cost
List saved audiences	`GET /v1/audiences`	Free (0 credits)
Save an audience	`POST /v1/audiences`	Free (0 credits)
Get a saved audience	`GET /v1/audiences/{id}`	Free (0 credits)
Update a saved audience	`PATCH /v1/audiences/{id}`	Free (0 credits)
Delete a saved audience	`DELETE /v1/audiences/{id}`	Free (0 credits)
Refresh a saved audience	`POST /v1/audiences/{id}/refresh`	Free (0 credits)

Quotes

Machine quotes (24 hours, free and public) and human sales quotes (14 days).

Operation	Endpoint	Cost
Quote an order	`POST /v1/quotes`	Free (0 credits)
Get a quote	`GET /v1/quotes/{id}`	Free (0 credits)

Orders

Spend credits against a machine quote; status, cancellation and the signed compliance receipt.

Operation	Endpoint	Cost
List orders	`GET /v1/orders`	Free (0 credits)
Create an order (spends credits)	`POST /v1/orders`	1 credit per complete UK record (uk_contacts). Suppressed, duplicate and already held records cost 0.
Get an order	`GET /v1/orders/{id}`	Free (0 credits)
Cancel a queued order	`POST /v1/orders/{id}/cancel`	Free (0 credits)
Get the compliance receipt	`GET /v1/orders/{id}/receipt`	Free (0 credits)

Records

Delivered records under licence, as pages or a signed download. Free.

Operation	Endpoint	Cost
Fetch order records	`GET /v1/orders/{id}/records`	Free (0 credits)
Download order records	`GET /v1/orders/{id}/download`	Free (0 credits)

Lookups

Company lookup (free) and contact enrichment (1 credit on a confident match).

Operation	Endpoint	Cost
Look up a company	`POST /v1/companies/lookup`	Free (0 credits)
Enrich a contact (spends credits)	`POST /v1/contacts/enrich`	1 credit on a confident match; 0 on no match or when already licensed.

Suppressions

Suppression lists, checks before a send, and objections.

Operation	Endpoint	Cost
List suppression lists	`GET /v1/suppressions`	Free (0 credits)
Upload a suppression list	`POST /v1/suppressions`	Free (0 credits)
Check suppression	`POST /v1/suppressions/check`	Free (0 credits)
Report an objection	`POST /v1/objections`	Free (0 credits)

Compliance

Public: the trust document, the LIA and compliance receipt verification.

Operation	Endpoint	Cost
Get the trust document	`GET /v1/trust`	Free (0 credits)
Get the legitimate interests assessment	`GET /v1/compliance/lia`	Free (0 credits)
Verify a compliance receipt	`POST /v1/compliance/receipts/verify`	Free (0 credits)

Account

Balance, plan, usage, credits bought by card, and ending a rolling plan.

Operation	Endpoint	Cost
Get the account	`GET /v1/account`	Free (0 credits)
Confirm the business details	`PATCH /v1/account`	Free (0 credits)
Accept the data processing agreement	`POST /v1/account/agreements`	Free (0 credits)
Get account usage	`GET /v1/account/usage`	Free (0 credits)
Cancel the plan	`POST /v1/account/cancel`	Free (0 credits)
List credit purchases	`GET /v1/account/purchases`	Free (0 credits)
Buy credits by card	`POST /v1/account/purchases`	Free (0 credits)
Get a credit purchase	`GET /v1/account/purchases/{id}`	Free (0 credits)

Keys

API keys and agent keys with budgets.

Operation	Endpoint	Cost
List API keys	`GET /v1/api-keys`	Free (0 credits)
Create an API key	`POST /v1/api-keys`	Free (0 credits)
Update an API key	`PATCH /v1/api-keys/{id}`	Free (0 credits)
Revoke an API key	`DELETE /v1/api-keys/{id}`	Free (0 credits)

CRM push

CRM connections, the New to you overlap check and record pushes.

Operation	Endpoint	Cost
List CRM connections	`GET /v1/connections`	Free (0 credits)
Create a CRM connection	`POST /v1/connections`	Free (0 credits)
Check CRM overlap	`POST /v1/connections/{id}/overlap`	Free (0 credits)
Push an order to a CRM	`POST /v1/orders/{id}/pushes`	Free (0 credits)
Get a push	`GET /v1/pushes/{id}`	Free (0 credits)
Retry a push	`POST /v1/pushes/{id}/retry`	Free (0 credits)

Webhooks

Webhook endpoints and the 30 day event log.

Operation	Endpoint	Cost
List webhook endpoints	`GET /v1/webhooks`	Free (0 credits)
Create a webhook endpoint	`POST /v1/webhooks`	Free (0 credits)
Delete a webhook endpoint	`DELETE /v1/webhooks/{id}`	Free (0 credits)
Send a test event	`POST /v1/webhooks/{id}/test`	Free (0 credits)
List events	`GET /v1/events`	Free (0 credits)

Operation	Endpoint	Cost
Get this OpenAPI document	`GET /v1/openapi.json`	Free (0 credits)
Check health	`GET /v1/health`	Free (0 credits)