API Reference

List Reference Checks

get
https://{subdomain}.pinpointhq.com/api/v1/reference_checks
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
extra_fields[reference_checks]
array of objects, unique

Include fields that are not always needed, or perhaps computationally expensive

include
array of strings, unique

Include related resources

fields[reference_checks]
array of objects, unique

Include only specified fields of Reference Check in response

fields[applications]
array of objects, unique

Include only specified fields of Application in response

fields[reference_check_field_answers]
array of objects, unique

Include only specified fields of Reference Check Field Answer in response

fields[reference_check_answers]
array of objects, unique

Include only specified fields of Reference Check Answer in response

string

Filter records by Reference checkable id

filter[reference_checkable_type]
array of strings, unique

Filter records by Reference checkable type

date-time

Filter records with created_at greater than this value

date-time

Filter records with created_at less than this value

date-time

Filter records with updated_at greater than this value

date-time

Filter records with updated_at less than this value

filter[status]
array of strings, unique

Filter records with status equal to this value

string

Filter records by Application id

string

Filter records by Job id

sort
array of strings, unique

Sort records according to one or more criteria

You should not include both ascending id and descending -id fields the same time

integer
Defaults to 1

The page number of records to return

integer
0 to 1000
Defaults to 100

The number of records to return

string
enum

Include the total number of matched records within the meta key of the response object.

Allowed:
Responses

Updated 2 days ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json

Updated 2 days ago