EmailmoversMyDataHub docs
Browse the docs

Reference / MCP tool reference

Reference

Get order status

get_order: Returns one order's status (queued, building, verifying, ready, failed or cancelled), counts, charges, licence and links to its records, download and receipt, or the recent orders when order_id is left out.

Generated from the contractsView as Markdown

Returns one order's status (queued, building, verifying, ready, failed or cancelled), counts, charges, licence and links to its records, download and receipt, or the recent orders when order_id is left out. Use it after create_order to wait for ready, or rely on the order.ready webhook. Free; it needs orders:read. Call fetch_order_records once the status is ready. Lawful basis is UK GDPR Article 6(1)(f) legitimate interests; email audiences include corporate subscribers only by default (PECR), so sole traders and ordinary partnerships are left out unless the toggle is changed.

PropertyValue
Tool nameget_order
Position in tools/list15 of 22
CostFree
Scopeorders:read
AnnotationsreadOnlyHint true, destructiveHint false, idempotentHint true, openWorldHint false
KindRead only; idempotent, not destructive, closed world
REST equivalentGET /v1/orders/{id}; GET /v1/orders

Input

The schema sets additionalProperties to false, so a member that is not listed is refused.

MemberTypeRequiredDescription
order_idstringnoThe order to return. Leave it out for the recent orders, newest first.
statusenum: queued, building, verifying, ready, failed, cancellednoqueued, building, verifying, ready; failed if processing failed; cancelled (only while queued).
limitinteger (1 to 100)noItems per page, 1 to 100. Default 25. Default 25.
cursorstringnoAn opaque cursor from next_cursor. Pass it back unchanged.

Example call

The params of a tools/call request:

{
  "name": "get_order",
  "arguments": {
    "order_id": "ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E"
  }
}

Output

The result carries structuredContent that matches this schema, and one line of text that leads with the number.

Order

MemberTypeAlways presentDescription
idstringyesFormat: an order id: ord_ followed by a 26 character ULID in upper case Crockford base32, such as ord_01JB4N9S3W2X6Y7Z8A1B2C3D4E.
statusenum: queued, building, verifying, ready, failed, cancelledyesqueued, building, verifying, ready; failed if processing failed; cancelled (only while queued).
namestringno
quote_idstringyesThe machine quote the order settled.
count_idstringyesThe count the machine quote was priced from.
dataset_versionstringnoThe immutable weekly build a count is bound to, such as 2026-W39. The last 52 stay queryable.
field_setstringno
deliveryarray of enum: api, csv, google_sheetsno
recordsinteger (0 or more)yes
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).
credits_remainingnumber (0 or more)yesThe balance right after this order was charged.
cost_gbpnumber (0 or more)yesThe charge in GBP excluding VAT at your plan's rate.
licence_expires_atstring (date) or nullyesWhen the licence ends; null for outright ownership.
licenceLicenceyesLicence terms as data, on every quote, order, records page and receipt. Records stay usable, pushable and re-downloadable free until reuse_until.
licence.typeenum: multi_use_12m, outrightyesmulti_use_12m (12 month multi-use, every plan) or outright (1.8 credits a record, proposed).
licence.reuse_untilstring (date) or nullyesOrder date plus 12 months; null for outright.
licence.resale_prohibitedbooleanyes
licence.permitted_channelsarray of enum: email, telephone, postyesemail, telephone and post on standard terms.
licence.warranty_urlstring (uri)yes
licence.terms_versionstringyesThe version of the Data Licence and Sharing Agreement the licence is under, such as 1.0.
licence.terms_urlstring (uri)noWhere that version of the Data Licence and Sharing Agreement is published.
confirmed_byConfirmedByyesWho approved the spend and from which client, recorded in the audit trail and on invoices.
confirmed_by.methodenum: elicitation_form, approval_url, agent_key, appyeselicitation_form (the MCP form), approval_url (the approval page's confirmation_token), agent_key (a pre-authorised agent key within its limits) or app (a person ordering in the app itself, a first-party session; third-party OAuth clients never count).
confirmed_by.key_idstringnoThe agent key, for agent_key.
confirmed_by.user_idstringnoThe person who confirmed.
confirmed_by.client_idstringnoThe OAuth client, such as a Client ID Metadata Document URL.
confirmed_by.user_agentstring or nullnoThe calling client's User-Agent.
confirmed_by.mtls_certificate_fingerprintstring or nullnoSHA-256 of the client certificate when one was presented (ChatGPT's mTLS).
confirmed_by.web_bot_auth_signature_agentstring or nullnoThe Signature-Agent of a verified Web Bot Auth signature, when present.
confirmed_by.confirmed_atstring (date-time)no
verificationobjectnoThe real-time check at delivery, such as 4,102 checked, 4,071 passed.
verification.checkedinteger (0 or more)yes
verification.passedinteger (0 or more)yes
verification.replacedinteger (0 or more)yes
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.
download_urlstring (uri-reference)no302 to a single-use signed URL that lives 5 minutes.
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.
validation_reportValidationReportLinksnoPresent once the order is ready.
validation_report.pdf_urlstring (uri)yes
validation_report.json_urlstring (uri)yes
buyer_kitBuyerKitnoFour signed documents that help the buyer use the list lawfully.
buyer_kit.draft_lia_urlstring (uri)yes
buyer_kit.first_email_wording_urlstring (uri)yes
buyer_kit.article30_stub_urlstring (uri)yes
buyer_kit.due_diligence_file_urlstring (uri)yes
created_atstring (date-time)no
ready_atstring (date-time) or nullno
failurestring or nullno

OrderList

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.

Errors

A failed call returns isError true. The text content leads with the sentence a person acts on, then the whole problem as JSON, with code, detail, next_step and did_you_mean. A 401 and a step-up 403 are answered at HTTP level so the client can start authorisation. See Errors.