v1

latestOpenAPI 3.0.02026-08-04350108.2 KB
labels

List labels

Retrieves all the labels and label groups available

This endpoint supports filtering and pagination through query parameters. Available ransackable attributes: uuid, name, parent_uuid, is_group.

Available ransackable associations and their attributes:

  • parent: parent_uuid, parent_name, parent_parent_uuid, parent_is_group
get/labels

Query parameters

pagenumber

Page number for pagination (default: 1)

per_pagenumber

Number of records per page (default: 20, max: 100)

limitnumber

Alias for per_page - number of records per page

limit_maxnumber

Maximum number of records per page (overrides limit if not set)

countstring

Set to 'true' to include total count in pagy metadata (data.pagy.count). Use for count/total queries instead of paginating through all pages.

qobject

Ransack query parameters for filtering. In query strings, use bracket notation: q[name_cont]=john&q[status_eq]=active&q[s]=name+asc. Keys are attribute names with predicates: _cont (contains), _eq (equals), _in (array membership), _gteq (>=), _lteq (<=), _present (not null), _null (is null). The "s" key sorts results (e.g., q[s]=created_at+desc). Example query string: ?q[name_cont]=john&q[s]=name+asc filters names containing "john" sorted by name ascending.