Skip to main content

List Support Groups

GET 
/api/support/admin/groups

Lists the support groups, each with tickets_count — the number of tickets of any status that carry the group's key. Exactly one group is the default (is_default), the one new tickets land in when nothing else picks a group.

Required scope: support:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Filtering: filter[search] matches the name, key and description at once; search_columns narrows it to named fields and search_strict_columns makes those fields match exactly. filter[is_default] is a flat true/false filter. Every other column is filtered with an operator suffix — filter[<column>.<operator>], e.g. filter[name.starts_with]=Bill. filter_groups expresses AND/OR and nested combinations.

Sorting: sort accepts id, name, key, position, tickets_count, created_at and updated_at, prefixed with - for descending. The default order is position, then id.

Pagination: standard pagination envelope — data plus current_page, last_page, per_page, total, from, to and the page links. per_page defaults to 10 and is capped at 100.

Response: each item carries id, key, name, description (nullable), position, is_default, tickets_count, created_at, updated_at.

Authentication: Bearer token with the support:read scope, or an authenticated session, from a caller with an active support role who also holds the support admin role. No tenant context — this endpoint is central.

Request​

Responses​

OK

Response Headers
    Content-Type