Get Group API

Retrieve a group

get

/groups/{id}

Retrieve a group by its identifier.

Authorizations

user-api-keystringRequired

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

Path parameters

idstring · uuidRequiredExample: 716305c4-561a-4561-a187-7f5b8aeb5920

Responses

200

The request has succeeded.

application/json

JSON:API document wrapping a single resource.

401

Authentication credentials are missing or invalid.

application/json

404

The requested resource does not exist.

application/json

422

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

application/json

get/groups/{id}

GET /api/v1/groups/{id} 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]"
            }
          }
        ]
      }
    }
  }
}