younifyd
Menu

Count Users

Count Users

GET/api/v2/users/count

Use it in a workflow

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

Request

Query parameters

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

brand_idoneOf

When brand separation is enabled, scopes the count to users belonging to the specified brand. Only applicable when the account has brand separation enabled. Accepted values: * "all" — count all users across all brands (no brand filtering applied). * 0 — count only account-scoped (brand-less) users. * A numeric brand id — if the brand has user separation enabled, count end users belonging to that brand plus all agents and admins (who are account-level and always included). If the brand does not have user separation enabled, the request falls back to account scope (0).

Response

Returns 200 with an object. Read it in later steps with {{countUsers.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.