Skip to main content
GET
/
account-groups
Get all company account groups
curl --request GET \
  --url https://openapi.pleo.io/v1/account-groups \
  --header 'Authorization: Bearer <token>'
{
  "metadata": {
    "pageInfo": {
      "pageSize": 123,
      "totalCount": 123,
      "nextPageOffset": 123
    }
  },
  "accountGroups": [
    {
      "id": "<string>",
      "name": "<string>",
      "typeKey": "entertainment",
      "hidden": true
    }
  ]
}

Authorizations

Authorization
string
header
required

Open API Bearer token

Query Parameters

pageOffset
number

This is the pagination offset value. The record number you would like to start from. This offset value starts at 0.

Example:

"150"

pageSize
number

The number of account groups to return for each page.

Example:

"10"

Response

Account groups has been returned

metadata
object
required

Additional metadata including pagination information

accountGroups
object[]