Skip to content

Orders

Screening orders placed for an applicant against a property.

Operations

List orders

Request

List the orders owned by your organization, newest first. The response is paginated — see next_href / previous_href for walking through pages. Live-mode keys see only live-mode orders; test-mode keys see only test-mode orders.

Security
bearer-token
Query
cursorstring

Opaque pagination token. Omit on the first request, then follow the next_href and previous_href URLs in the response — those URLs already have the correct cursor encoded. Cursors from one endpoint are not valid on another. An invalid cursor returns 422.

per_pageinteger, [ 1 .. 100 ]

Page size. Defaults to 25; the maximum is 100. The chosen size is preserved on next_href and previous_href, so you only need to set it on the first request of a walk.

Default:25
includestring

Comma-separated list of related objects to embed in the response. Supported values: property, applicant. By default only the property_id and applicant_id are returned.

Example:include=property,applicant
Headers
Checkr-Tenant-Versionstring

CalVer-dated API version to pin behavior to (e.g. 2026-04-29). When omitted, the request is served by the newest supported version. Unknown values return 422.

Value:"2026-04-29"
GET
/orders
curl -i -X GET \
  'https://tenant.checkr.com/api/orders?cursor=string&per_page=25&include=property%2Capplicant' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Checkr-Tenant-Version: 2026-04-29'

Responses

OK

Bodyapplication/json
objectstring

Always list for list responses.

Value:"list"
countinteger

Total number of records in the underlying collection (across all pages), not the size of data.

next_hrefstring or null, (uri)

Absolute URL of the next page (older records), or null if this is the last page.

previous_hrefstring or null, (uri)

Absolute URL of the previous page (newer records), or null if this is the first page.

dataArray of objects(order)

Orders on this page, ordered newest first.

Response
{
  "object": "list",
  "count": 0,
  "next_href": "http://example.com",
  "previous_href": "http://example.com",
  "data": [
    { … }
  ]
}