Get list of Groups API

List groups

get

/groups

List groups. Results are paginated; the meta block carries the page, limit, total and ordering.

Authorizations

user-api-keystringRequired

API key for programmatic access, sent in the user-api-key header.

Query parameters

filter[title]stringOptional

Return only groups with exactly this title.

pagination[page]integer · int32 · min: 1Optional

Page to return, counted from 1.

pagination[limit]integer · int32 · min: 1 · max: 100Optional

Number of items per page. Maximum is 100.

order[title]string · enumOptional

Sort direction for list results.

Possible values:

Responses

200

The request has succeeded.

application/json

JSON:API document wrapping a collection of resources with pagination meta.

401

Authentication credentials are missing or invalid.

application/json

422

The request has missing or invalid arguments; details lists the messages per argument.

application/json

get/groups

GET /api/v1/groups HTTP/1.1
Host: app.channex.io
user-api-key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "type": "group",
      "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
      "attributes": {
        "id": "f71f6a62-d49a-4f2f-ae90-4f81d347ff67",
        "title": "User Group"
      },
      "relationships": {
        "properties": {
          "data": [
            {
              "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
              "type": "property",
              "attributes": {
                "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
                "title": "Property 1"
              }
            }
          ]
        },
        "users": {
          "data": [
            {
              "type": "user",
              "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
              "attributes": {
                "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
                "name": "Channex User",
                "email": "[e-mail]"
              }
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "order_by": "inserted_at",
    "order_direction": "desc"
  }
}