List Orders

GET https://api.speccheckrx.com/v1/orders

Authentication

This endpoint requires bearer token authentication.

Headers

string

required

Your bearer token in the format Bearer <token>.

string

required

The email address of the user making the request.Must exactly match the email address used to log in to the SpecCheck Dashboard.

Parameters

string

required

The ID of the lab for this request.

string

required

The lab account number for this request.

object

Only return orders that were created during the given date interval.

Show created

integer

Minimum value to filter by (exclusive).

integer

Minimum value to filter by (inclusive).

integer

Maximum value to filter by (exclusive).

integer

Maximum value to filter by (inclusive).

string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

string

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

integer

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Returns

Returns an object with a data array of orders and a has_more pagination flag. If there are no matching orders, data is an empty array.

boolean

Whether there are more orders available beyond this page.

array of Order Object

Show Order

string

The unique identifier for the order.

string

The tray number for the order.

string

The invoice number for the order.

string

The current status of the order at the lab.

integer

Time at which the object was created. Measured in seconds since the Unix epoch.

integer

Time at which the object was last updated. Measured in seconds since the Unix epoch.

{
  "has_more": false,
  "data": [
    {
      "id": "ord_1234",
      "tray_number": "1234",
      "invoice_number": "1234",
      "lab_status": "in_progress",
      "created": 1710000000,
      "updated": 1710003600
    }
  ]
}

curl -g "https://api.speccheckrx.com/v1/orders?lab={{LAB_ID}}&account_number={{ACCOUNT_NUMBER}}&created[gte]={{CREATED_GTE}}" \
  -H "Authorization: Bearer {{ACCESS_TOKEN}}" \
  -H "User-Email: {{USER_EMAIL}}"

Get Started

Core Resources

Authentication

Headers

Parameters

Returns

​Authentication

​Headers

​Parameters

​Returns

Authentication

Headers

Parameters

Returns