Count Group Users

Count Users By Group

GET/api/v2/groups/{group_id}/users/count

Use it in a workflow

Add a step and choose the Zendesk connector.
Pick the Count Group Users action (under Users).
Fill in the fields below, then reference the result from later steps as {{countGroupUsers.response.data}}.

group_idinteger (int64)required

The ID of the group

rolestring

Filters the results by role. Possible values are "end-user", "agent", "admin", or a custom role name

role[]array<string>

Filters the results by more than one role using the format `role[]={role}&role[]={role}`

permission_setinteger (int64)

For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request

Returns 200 with an object. Read it in later steps with {{countGroupUsers.response.data.<field>}}.

countobject

refreshed_atstring (date-time)

valueinteger

json

{
  "count": {
    "refreshed_at": "2025-01-01T00:00:00Z",
    "value": 0
  }
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.

Was this page helpful?