Sign in
latestOpenAPI 3.1.0MIT2026-08-102046250.0 KB

67cb925f1c81

Groups

List Groups

With the list operation you can list all groups that you have created. This operation supports pagination.

Groups are returned in reverse chronological order.

get/xms/v1/{service_plan_id}/groups

Query parameters

pageinteger

The page number starting from 0.

page_sizeinteger

Determines the size of a page.

Response

A successful response, or an Error.

countinteger

The total number of groups.

pageinteger

The requested page.

page_sizeinteger

The number of groups returned in this request

Example response

{
  "count": 2,
  "groups": [
    {
      "id": "01FC66621VHDBN119Z8PMV1QPQ",
      "name": "My new customers",
      "size": 2,
      "child_groups": [
        "01FC66621VHDBN119Z8PMV1AHY"
      ],
      "auto_update": {
        "to": "+15551231234",
        "add": {
          "first_word": "Sinch",
          "second_word": "JOIN"
        },
        "remove": {
          "first_word": "LEAVE"
        }
      }
    }
  ],
  "page_size": 2
}