Spot home pagelight logo
  1. API Reference - Orders
  2. List orders
GET

/api/v2/orders/

email
first_name
last_name
phone
status
created_before
created_after
updated_before
updated_after
results
offset
curl --request GET \
     --url https://app.spotdx.com/api/v2/orders/ \

[
  {
    "order_id": "O1234567",
    "status": "pending",
    "recipient": {
      "first_name": "Alice",
      "last_name": "Smith",
      "email": "alice123@gmail.com",
      "phone": "1234567890",
      "address": {
        "street1": "123 Main St",
        "street2": "Apt 1",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "zip": "94105"
      }
    },
    "created": "2023-01-01T04:30:11.222Z",
    "updated": "2023-01-01T04:30:11.222Z"
  }
]

​
Parameters

email
string

Only retrieve orders associated with this email address.

first_name
string

Only retrieve orders associated with this first name.

last_name
string

Only retrieve orders associated with this last name.

phone
string

Only retrieve orders associated with this phone number.

status
string

Only retrieve orders that have this status.

created_before
string

Only retrieve orders created on or before this date. Format: YYYY-MM-DD

created_after
string

Only retrieve orders created on or after this date. Format: YYYY-MM-DD

updated_before
string

Only retrieve orders updated on or before this date. Format: YYYY-MM-DD

updated_after
string

Only retrieve orders updated on or after this date. Format: YYYY-MM-DD

results
integer

Number of results to return. Must be in range 1-100. Default is 10.

offset
integer

The initial index from which to return the results.

​
Response

array