List Contacts

Returns a paginated list of contacts. Supports filtering by phone, name, update_time, remote_id, type, state, and birth_date.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
1 to 1000

The maximum number of contacts to return. The service may return fewer than this value. If unspecified, at most 50 contacts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

string

A page token, received from a previous ListContacts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListContacts must match the call that provided the page token.

string

Comma-separated list of fields to order results by (e.g., "family_name asc, given_name asc").

string

Filter expression to narrow the returned results. Supported filter fields are: phone, name, update_time, remote_id, type, state, and birth_date. The phone and name filters are case-insensitive and perform partial matching. Example: type='PATIENT' AND state='ACTIVE' AND name='john' returns all active patients named John. See https://aip.kolla.dev/160 for full filter syntax.

Responses

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