List of Groups

Retrieve a list of Groups

Parameter

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

Example

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

📘

This method accepts application/json

Parameter

Example

Required

Description

Parameter type

since

123124122

Optional

Name of the first group to be retrieved in ascending order

Query

limit

25

Optional

Restrict the maximum number of results

  • min : 1
  • max : 500
  • default : 25

Query

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": 1624422348044,
      "updatedAt": 1624422348044,
      "active": true
    }
  ]
}