Skip to content

tags

A collection of tags related to current patient/provider/organization

Arguments

applied_to_providers · Boolean · When true, only returns tags applied to providers in the organization.
ids · [ID] · Filter results to only tags with the specified IDs.
order_by · TagOrderKeys · Sort order for returned tags. Supports sorting by name, patient count, organization member count, or creator name. Defaults to name ascending. See 'Tag Order Keys' for more information.
user_id · String · Filter results to tags owned by the specified user. Ignored if the current user has see_all_clients permission.
sort_by · String · Options are name_desc, name_asc, active_users_desc, active_users_asc, added_by_asc, added_by_desc, org_members_asc, org_members_desc

Returns

[Tag!]

Example

query tags(
$applied_to_providers: Boolean
$ids: [ID]
$order_by: TagOrderKeys
$user_id: String
$sort_by: String
) {
tags(
applied_to_providers: $applied_to_providers
ids: $ids
order_by: $order_by
user_id: $user_id
sort_by: $sort_by
) {
active_users_count
added_by
archived_users_count
created_at
id
name
org_members_count
patients_tagged_count
providers_tagged_count
tagged_users
updated_at
user
}
}