Skip to content

Nodes

Nodes are the individual entities that comprise an Account Hierarchy. If hierarchy is enabled for your Checkr Account, this endpoint may be used to retrieve a list of all Account Nodes. To create Nodes, use the Create Hierarchy endpoint.

Operations

List existing Nodes

Request

Returns a list of existing Nodes that make up the current Account Hierarchy.

  • If include=packages is passed, each Node object in the response will include a "packages" field. This will be an array of strings representing the slugs of the account Packages that are assigned (directly or indirectly) to the given Node. This field can be used to build UIs that truncate the list of Packages displayed to a requester, or to display only the nodes that are relevant to the requester.

  • If include=packages is not passed, no package information will be included in the response.

This endpoint uses pagination; please see the corresponding reference page for details.

Security
basic_auth
Query
includestring

Includes a "packages" array with each Node object, containing a list of slugs for packages that are assigned to that node or its ancestors.

Value:"packages"
Example:include=packages
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.

order_bystring or null

Returns records sorted by custom_id or created_at. If neither is specified, records will be sorted by created_at.

Enum:"custom_id""created_at"
Example:order_by=custom_id
orderstring or null

Returns records arranged in order as specified by the order_by parameter. If neither is specified, records will be listed in ascending order.

Enum:"asc""desc"
Example:order=desc
curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/nodes?include=packages&page=0&per_page=0&order_by=custom_id&order=desc'

Responses

List of Nodes

Bodyapplication/json
objectstring

A list

Value:"list"
next_hrefstring, (uri)
previous_hrefstring, (uri)
countinteger
Example:2
dataArray of objects(Node)
Response
{
  "object": "list",
  "next_href": "http://example.com",
  "previous_href": "http://example.com",
  "count": 2,
  "data": [
    { … }
  ]
}
© Checkr, Inc.