GET /v2/groups

{
  "groups": [
    {
      "id": "a5a885caee6286a54ad7bbd4ab5400e9",
      "name": "Annature group",
      "business": "Annature",
      "email": "ted@annature.com.au",
      "number": "1300 000 000",
      "address": "Level 38, 71 Eagle Street, Brisbane 4000",
      "website": "www.annature.com.au",
      "logo": "https://annature..",
      "color": "#5469d4",
      "created": "2019-12-17T05:30:00Z"
    }
  ],
  "cursor": "eyJpZCI6ImYxMjMiLCJjcmVhdGVkIjoiMjAyNS0wNy0wOVQwODozMDowMFoifQ==",
  "has_more": true
}
Returns a paginated list of all groups configured for your organisation. Groups are returned in descending order of creation time, with the most recently created groups appearing first. Each group object includes contact details, branding information, and business identifiers used to theme envelopes and route shared access. Filtering and result structure is identical to the original List all groups endpoint, with the addition of cursor-based pagination. To retrieve the next page of results, pass the cursor value from the previous response into your next request. The has_more property will indicate whether additional results are available.

​
Parameters

​
name
optional
Filter by exact match on the group’s name property.
​
business
optional
Filter by exact match on the group’s business property.
​
email
optional
Filter by exact match on the group’s email property.
​
cursor
optional
Pagination cursor returned from a previous request. Use this to fetch the next page of results.
GET /v2/groups

{
  "groups": [
    {
      "id": "a5a885caee6286a54ad7bbd4ab5400e9",
      "name": "Annature group",
      "business": "Annature",
      "email": "ted@annature.com.au",
      "number": "1300 000 000",
      "address": "Level 38, 71 Eagle Street, Brisbane 4000",
      "website": "www.annature.com.au",
      "logo": "https://annature..",
      "color": "#5469d4",
      "created": "2019-12-17T05:30:00Z"
    }
  ],
  "cursor": "eyJpZCI6ImYxMjMiLCJjcmVhdGVkIjoiMjAyNS0wNy0wOVQwODozMDowMFoifQ==",
  "has_more": true
}