API ReferencePatient ArV1

List Inventory Records

Beta

NOTE: This service is in-development and can only be used by select partners. Please contact Candid Health to request access.

Retrieve a list of inventory records based on the provided filters. Each inventory record provides the latest invoiceable status of the associated claim. The response is paginated, and the page_token can be used to retrieve subsequent pages. Initial requests should not include page_token.

Headers

AuthorizationstringRequired

OAuth authentication of the form <token>.

Query parameters

sincedatetimeOptional
Timestamp to filter records since, inclusive
limitintegerOptionalDefaults to 100
Maximum number of records to return, default is 100
page_tokenstringOptional

Response

This endpoint returns an object.
recordslist of objects
List of inventory records matching the filters
next_page_tokenstring or null
Token for the next page of results, if available

Errors