EmailmoversMyDataHub docs
Browse the docs

Reference / REST reference

Reference

List orders

GET /v1/orders. Recent orders with status, counts and links, newest first.

Generated from the contractsView as Markdown

GET /v1/orders

Recent orders with status, counts and links, newest first.

PropertyValue
EndpointGET https://mydatahub.emailmovers.com/v1/orders
Operation idlistOrders
CostFree (0 credits)
AccessAn API key or an OAuth 2.1 token with the scope orders:read.
MCP toolget_order
TagOrders

Request

Parameters

NameInTypeRequiredDescription
statusqueryenum: queued, building, verifying, ready, failed, cancellednoqueued, building, verifying, ready; failed if processing failed; cancelled (only while queued).
limitqueryinteger (1 to 100)noItems per page, 1 to 100. Default 25.
cursorquerystringnoAn opaque cursor from next_cursor. Pass it back unchanged.
MyDataHub-VersionheaderstringnoThe 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/orders" \
  -H "Authorization: Bearer $MYDATAHUB_API_KEY"

Responses

200: A page of orders.

Headers: RateLimit, RateLimit-Policy.

MemberTypeAlways presentDescription
dataarray of Orderyes
data[].idstringyesFormat: an order id: ord_ followed by a 26 character ULID in upper case Crockford base32, such as ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E.
data[].statusenum: queued, building, verifying, ready, failed, cancelledyesqueued, building, verifying, ready; failed if processing failed; cancelled (only while queued).
data[].namestringno
data[].quote_idstringyesThe machine quote the order settled.
data[].count_idstringyesThe count the machine quote was priced from.
data[].dataset_versionstringnoThe immutable weekly build a count is bound to, such as 2026-W39. The last 52 stay queryable.
data[].field_setstringno
data[].deliveryarray of enum: api, csv, google_sheetsno
data[].recordsinteger (0 or more)yes
data[].credits_chargednumber (0 or more)yesCredits, to one decimal place: whole at 1 credit a record, fractional only where a rule is (0.1 company-only, 1.8 outright, both proposed).
data[].credits_remainingnumber (0 or more)yesThe balance right after this order was charged.
data[].cost_gbpnumber (0 or more)yesThe charge in GBP excluding VAT at your plan's rate.
data[].licence_expires_atstring (date) or nullyesWhen the licence ends; null for outright ownership.
data[].licenceLicenceyesLicence terms as data, on every quote, order, records page and receipt. Records stay usable, pushable and re-downloadable free until reuse_until.
data[].confirmed_byConfirmedByyesWho approved the spend and from which client, recorded in the audit trail and on invoices.
data[].verificationobjectnoThe real-time check at delivery, such as 4,102 checked, 4,071 passed.
data[].records_urlstring (uri-reference)yesA path on https://mydatahub.emailmovers.com starting /v1/. Resolve it against the origin (RFC 3986), not by appending it to the server URL.
data[].download_urlstring (uri-reference)no302 to a single-use signed URL that lives 5 minutes.
data[].receipt_urlstring (uri-reference)noA path on https://mydatahub.emailmovers.com starting /v1/. Resolve it against the origin (RFC 3986), not by appending it to the server URL.
data[].validation_reportValidationReportLinksnoPresent once the order is ready.
data[].buyer_kitBuyerKitnoFour signed documents that help the buyer use the list lawfully.
data[].created_atstring (date-time)no
data[].ready_atstring (date-time) or nullno
data[].failurestring or nullno
has_morebooleanyesWhether another page follows.
next_cursorstring or nullyesPass as cursor to fetch the next page; null on the last page.

Example response

{
  "data": [
    {
      "id": "ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E",
      "status": "ready",
      "credits_charged": 5000,
      "records": 5000,
      "confirmed_by": {
        "method": "agent_key",
        "key_id": "key_01JB3Z4Q2V7XN3M9R6T1Y5W8ZA",
        "client_id": "https://claude.ai/oauth/claude-code-client-metadata",
        "user_agent": "claude-code/2.1",
        "mtls_certificate_fingerprint": null,
        "web_bot_auth_signature_agent": null,
        "confirmed_at": "2026-09-26T10:16:00Z"
      },
      "records_url": "/v1/orders/ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E/records",
      "quote_id": "qte_01JB4M2R6T1Y5W8ZAK8Q2V7XN3",
      "count_id": "cnt_7K2PQ4MAXN3R6TBY5WDZ",
      "credits_remaining": 1200,
      "cost_gbp": 1495,
      "licence_expires_at": "2027-09-26",
      "licence": {
        "type": "multi_use_12m",
        "reuse_until": "2027-09-26",
        "resale_prohibited": true,
        "permitted_channels": ["email", "telephone", "post"],
        "warranty_url": "https://emailmovers.com/trust/warranty",
        "terms_version": "2026-09"
      },
      "name": "Leeds marketing Q4",
      "dataset_version": "2026-W39",
      "field_set": "standard",
      "delivery": ["api", "csv"],
      "verification": {
        "checked": 5000,
        "passed": 4962,
        "replaced": 38
      },
      "download_url": "/v1/orders/ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E/download",
      "receipt_url": "/v1/orders/ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E/receipt",
      "validation_report": {
        "pdf_url": "https://mydatahub.emailmovers.com/orders/ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E/validation-report.pdf",
        "json_url": "https://mydatahub.emailmovers.com/orders/ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E/validation-report.json"
      },
      "buyer_kit": {
        "draft_lia_url": "https://mydatahub.emailmovers.com/orders/ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E/kit/lia",
        "first_email_wording_url": "https://mydatahub.emailmovers.com/orders/ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E/kit/first-email",
        "article30_stub_url": "https://mydatahub.emailmovers.com/orders/ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E/kit/article30",
        "due_diligence_file_url": "https://mydatahub.emailmovers.com/orders/ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E/kit/due-diligence"
      },
      "created_at": "2026-09-26T10:16:00Z",
      "ready_at": "2026-09-26T10:16:04Z",
      "failure": null
    }
  ],
  "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.

StatusProblem codesWhen
400invalid-request, idempotency-key-required, unsupported-versionThe request could not be read, or an Idempotency-Key is missing.
401authentication-required, account-requiredSign in (OAuth) or send an API key (authentication-required), or create a free account for what the anonymous tier does not cover (account-required).
403insufficient-scope, confirmation-required, business-details-required, licence-acceptance-required, dpa-acceptance-required, agent-budget-exceededThe 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.
422validation-failed, quote-required, dataset-unavailableThe request is not valid. errors lists every problem with a JSON pointer and did_you_mean.
429rate-limitedToo many requests. Wait for Retry-After.
Any other failureinternal-error, service-unavailable, tps-screen-expiredSomething 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.