List of Groups

Retrieve a list of Groups

Parameter

Accessible via URL https://api.channel.io/open/v5/groups and HTTP GET

📘

This method accepts application/json

ParameterExampleRequiredDescriptionParameter type
since123124122OptionalName of the first group to be retrieved in ascending orderQuery
limit25OptionalRestrict the maximum number of results
- min : 1
- max : 500
- default : 25
Query

Example

GET https://api.channel.io/open/v5/groups

Response

Returns a list of Group objects.

{
  "next": "string",
  "groups": [
    {
      "id": "string",
      "channelId": "string",
      "name": "string",
      "scope": "all",
      "managerIds": [
        "string"
      ],
      "icon": "string",
      "description": "string",
      "createdAt": 1656032149398,
      "updatedAt": 1656032149399,
      "active": true
    }
  ]
}