List groups
/api/v2/groupsAuthorization
bearerAuth In: header
Query Parameters
Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.
uuid1 <= value <= 20015Only groups in this set.
uuidOnly direct children of this group.
uuidPartial match on the label.
Exact slug.
Exact sort order, or a range with sort_order[gte] and the other range operators.
Exact created_at, or a range with created_at[gte], created_at[lte], created_at[gt] and created_at[lt]. Values are dates or date-times.
Exact updated_at, or a range with updated_at[gte], updated_at[lte], updated_at[gt] and updated_at[lt]. Values are dates or date-times.
Sort by any filter field; prefix with - for descending.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v2/groups"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "group_set_id": "90dcd050-0bc2-4e3a-b042-5b7bebcd5079", "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef", "label": "string", "slug": "string", "description": "string", "color": "string", "sort_order": 0, "children": [ {} ], "group_set": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "key": "string", "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5", "object_type": "property", "allows_multiple_membership": true, "groups_count": 0, "groups": [ {} ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "links": { "first": "string", "last": "string", "prev": "string", "next": "string" }, "meta": { "current_page": 0, "from": 0, "last_page": 0, "links": [ { "url": "string", "label": "string", "page": 0, "active": true } ], "path": "string", "per_page": 200, "to": 0, "total": 0 }}