List existing Subscriptions

Request

Lists existing Subscriptions with the input parameters.

Security

basic_auth

Query

candidate_idstring

ID of the candidate to search for subscriptions.

created_afterstring, (date-time)

Returns subscriptions created after the input date.

created_beforestring, (date-time)

Returns subscriptions created before the input date.

statusstring

Returns subscriptions with the input status.

Enum:"active""inactive"

pagenumber or null

Specifies the page number to retrieve.

per_pagenumber or null

Indicates how many records each page should contain. The default value is 25 records.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/subscriptions?candidate_id=string&created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&status=active&page=0&per_page=0'

Responses

List of Subscriptions

Bodyapplication/json

objectstring

A list

Value:"list"

next_hrefstring, (uri)

previous_hrefstring, (uri)

countinteger

Example:2

dataArray of objects(Subscription)

Response

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