Orders
Find orders by reference or metadata
Searches the account's orders by reference or metadata, and can limit the fields returned. The response is not paginated. A test key (sk_test_) only finds test orders, a live key only real orders.
Request
Authorization
Bearer token
Send your API key in the Authorization header: Authorization: Bearer sk_test_…. A sk_test_ key creates and sees test orders only. Keys and test mode.
Path parameters
accountIdstringrequiredUnique identifier of the account
Query parameters
metadatastringFilter orders based on metadatareferencestringFilter orders based on referencefieldsstringGet only wanted fields
Responses
200Successfully retrieved orders
successbooleanordersarray of Order
401Unauthorized, authentication required, or an OAuth access token unknown, expired or revoked (INVALID_TOKEN)
Type: Error
403The API key is inactive or revoked (INACTIVE_API_KEY), or targets another account (ACCOUNT_ACCESS_DENIED, refused once the account guard is enforced); with an OAuth access token: a token of scope mcp (INSUFFICIENT_SCOPE), a path naming another account or a person no longer a member of it (ACCOUNT_ACCESS_DENIED), a real token on the sandbox host (SANDBOX_REQUIRES_TEST_KEY)
Type: Error
429
500Server error
Type: Error