Skip to main content
GET
List a contact's orders

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company.

Headers

If-None-Match
string

ETag from a previous response.

Path Parameters

id
string<uuid>
required

Public id of one of the member's contacts.

Query Parameters

filter[status]
enum<string>

Match the order lifecycle state.

Available options:
draft,
pending,
pending_review,
processing,
completed,
cancelled,
archived
filter[placed_since]
string<date-time>

Include orders placed at or after this timestamp.

filter[placed_until]
string<date-time>

Include orders placed at or before this timestamp; must not precede placed_since.

page[cursor]
string

Encrypted next-page cursor, valid for three days.

page[limit]
integer
default:25

Maximum number of orders returned.

Required range: 1 <= x <= 100

Response

A page of the contact's orders.

A page of orders.

status
integer
required

HTTP response status.

data
object[]
required

Matching orders on this page.

meta
object
required

Envelope metadata present on every response.