Retrieve order resources

Retrieve order resources is used to retrieve all orders filtered by parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Returns orders matching this specific candidate name.

string

Returns orders matching this specific candidate name.

string

Returns orders matching this specific candidate name.

string

Returns orders matching the specific SSN.

string
enum

Returns orders matching the specific status.

Allowed:
string
enum

Returns orders matching the specific result.

Allowed:
string
enum

Returns orders matching the specific result.

Allowed:
string
enum

Returns orders matching the specific result.

string
^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}Z)?$

Orders created at a specific date/time. Accepted formats:

  • YYYY-MM-DD (e.g. 2020-03-11)
  • YYYY-MM-DDTHH:MM:SSZ (e.g. 2019-12-06T19:07:20Z)
string
^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}Z)?$

Orders created at a specific date/time. Accepted formats:

  • YYYY-MM-DD (e.g. 2020-03-11)
  • YYYY-MM-DDTHH:MM:SSZ (e.g. 2019-12-06T19:07:20Z)
string
^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}Z)?$

Orders created at a specific date/time. Accepted formats:

  • YYYY-MM-DD (e.g. 2020-03-11)
  • YYYY-MM-DDTHH:MM:SSZ (e.g. 2019-12-06T19:07:20Z)
string
^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}Z)?$

Orders completed after a specific date/time. Accepted formats:

  • YYYY-MM-DD (e.g. 2020-03-11)
  • YYYY-MM-DDTHH:MM:SSZ (e.g. 2019-12-06T19:07:20Z)
string
^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}Z)?$

Orders completed before a specific date/time. Accepted formats:

  • YYYY-MM-DD (e.g. 2020-03-11)
  • YYYY-MM-DDTHH:MM:SSZ (e.g. 2019-12-06T19:07:20Z)
string
^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}Z)?$

Orders updated after a specific date/time. Accepted formats:

  • YYYY-MM-DD (e.g. 2020-03-11)
  • YYYY-MM-DDTHH:MM:SSZ (e.g. 2019-12-06T19:07:20Z)
string
^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}Z)?$

Orders updated before a specific date/time. Accepted formats:

  • YYYY-MM-DD (e.g. 2020-03-11)
  • YYYY-MM-DDTHH:MM:SSZ (e.g. 2019-12-06T19:07:20Z)
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json