Pagination

Bridge’s API uses page-style pagination. Use the page query parameter to set the page index, zero-based.

1
/api/services?page=4

Limits

By default, list API’s have a limit value of 100. That can be increased, though some API’s may have a ceiling (documented in API Reference).

Configure this using the limit query paramtere, available on all list endpoints.

Response

List API’s have a standardized “List Response” format, an items array (the results for the page) and a count value (the total count of all resources). The count may not be present on some endpoints (note in API reference).

1
{
2
  "items": [
3
    { ... },
4
    { ... },
5
    { ... }
6
  ],
7
  "count": 134
8
}

Filtering

Some endpoints support basic filtering, using query parameters. Only the parameters documented in the API Reference are supported. If multiple filters are used, they’re evaluated as an AND.

1
/api/services?filter.patientId=pat_N48mIab&filter.serviceTypeId=stid_m17Zh8o

Ordering

List endpoints have an appropriate default ordering, but this may be configured for some endpoints. Where documented, use the order. query parameters, value is asc or desc. These can be used in conjunction with filter. parameters.

1
/api/services?order.createdAt=desc