Skip to main content

contacts

This query fetches a collection of contacts that match the requested filters. Optional free-text search is compared against the contact's name, email address, telephone number(s), medical specialisation, and numbers (such as NHS Number). Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.

contacts(
  search: String
  pagination: Pagination
  cursorPagination: CursorPagination
  options: QueryOptions
  filters: ContactsQueryFilters
): ContactData

Arguments​

contacts.search ● String scalar​

contacts.pagination ● Pagination input​

contacts.cursorPagination ● CursorPagination input​

Cursor-based pagination alternative to pagination. Mutually exclusive with pagination. Use the last contact's id as cursor for the next page. Results are always ordered by _id ascending for NEXT (and descending then reversed for PREVIOUS).

contacts.options ● QueryOptions input​

contacts.filters ● ContactsQueryFilters input​

Type​

ContactData object​

A collection of contacts and the associated pagination information. With offset pagination, pageInfo is a standard PageInfo. With cursorPagination, pageInfo uses the PageInfoForCursorPagination shape (pageSize and hasMore only; page is unset).