Skip to main content

users

This query fetches a collection of users that belong to the same practice as the API user making the request. The results are paginated depending on the requested paging parameters. The query can be further refined through the use of UsersQueryOptions to filter users by their creation date or last update date, search by name, email, or metadata values, or set includeDeleted to true to include users who have been deleted in Semble. Use filters.isClinician to filter clinicians, filters.metadata to filter by stored customerMetadata entries. options.cliniciansOnly is deprecated; use filters.isClinician instead.

users(
  pagination: Pagination
  options: UsersQueryOptions
  filters: UsersQueryFilters
): UserData

Arguments​

users.pagination ● Pagination input​

users.options ● UsersQueryOptions input​

users.filters ● UsersQueryFilters input​

Type​

UserData object​

A collection of users and information regarding how the colllection is paginated.