Skip to main content
GET
/
groups
List groups
curl --request GET \
  --url https://cookiechimp.com/api/v1/groups \
  --header 'Authorization: Bearer <token>'
{
  "pagination": {
    "prev_url": "/api/v1/groups?page=",
    "next_url": "/api/v1/groups?page=2",
    "count": 4,
    "page": 1,
    "prev": null,
    "next": 2
  },
  "data": [
    {
      "id": "abc123",
      "name": "Example Ltd",
      "external_id": "ABC_123",
      "partner": "partner_one",
      "max_pageviews_per_month": 500000
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API token obtained from the login endpoint or the dashboard

Query Parameters

​
per_page
integer
default:20

Number of records to return per page

Required range: 1 <= x <= 50
​
page
integer
default:1

Page number

Response

200 - application/json

List of groups

​
pagination
object
Example:
{
  "prev_url": "/api/v1/groups?page=",
  "next_url": "/api/v1/groups?page=2",
  "count": 4,
  "page": 1,
  "prev": null,
  "next": 2
}
​
data
object[]