API ReferenceServices

List Services

Authentication

X-API-Keystring
API Key authentication via header

Query parameters

filter.serviceTypeIdstringOptional

should be JSON-encoded, for example filter.serviceTypeId=“svt_xxx”

filter.patientIdstringOptional

should be JSON-encoded, for example filter.patientId=“pat_xxx”

filter.statuslist of enumsOptional

should be a JSON-encoded array, for example filter.status=[“PENDING”, “COMPLETE”]

filter.providerIdlist of stringsOptional

should be JSON-encoded array, for example filter.providerId=[“prv_xxx”, “prv_yyy”]

order.createdAtenumOptional
Allowed values:
pageintegerOptional
limitintegerOptional

Response

This endpoint returns an object.
itemslist of objects
List results
countinteger or null

Total count (if available)