---
title: "List Groups"
method: GET
path: "/xms/v1/{service_plan_id}/groups"
tags: ["Groups"]
---

# List Groups

`GET /xms/v1/{service_plan_id}/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.

## Query parameters

- `page` integer
- `page_size` integer

## Response `200`

A successful response, or an [Error](https://developers.sinch.com/docs/sms/api-reference/status-codes).

- ApiGroupList
  - `count` integer — The total number of groups.
  - `page` integer — The requested page.
  - `groups` ApiGroup[]
    - `id` string — The ID used to reference this group.
    - `name` string — Name of group if set.
    - `size` integer — The number of members currently in the group.
    - `created_at` string, date-time — Timestamp for group creation. Format: YYYY-MM-DDThh:mm:ss.SSSZ
    - `modified_at` string, date-time — Timestamp for when the group was last updated. Format: YYYY-MM-DDThh:mm:ss.SSSZ
    - `child_groups` MtGroupId[] — Phone numbers [MSIDNs](https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628) of child group will be included in this group. If present then this group will be auto populated. Constraints: Elements must be group IDs.
    - `auto_update` ApiGroupAutoUpdate
      - `to` string, E.164, required — Short code or long number addressed in [MO](https://community.sinch.com/t5/Glossary/MO-Mobile-Originated/ta-p/7618). Constraints: Must be valid phone number or short code which has been **provisioned by your account manager**.
      - `add` AddKeyword — Keyword to be sent in MO to add MSISDN to a group
        - `first_word` string, required — Opt-in keyword like "JOIN" if _auto_update.to_ is dedicated long/short number or unique brand keyword like "Sinch" if it is a shared short code.
        - `second_word` string — Opt-in keyword like "JOIN" if _auto_update.to_ is shared short code.
      - `remove` RemoveKeyword — Keyword to be sent in MO to remove MSISDN to a group
        - `first_word` string, required — Opt-out keyword like "LEAVE" if _auto_update.to_ is dedicated long/short number or unique brand keyword like "Sinch" if it is a shared short code.
        - `second_word` string — Opt-out keyword like "LEAVE" if _auto_update.to_ is shared short code.
  - `page_size` integer — The number of groups returned in this request

## Other responses

- `400` — Bad request

---

[API](https://skmtc.net/sinch/apis/api-overview-sinch.md) · [All operations](https://skmtc.net/sinch/apis/api-overview-sinch/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sinch/api-overview-sinch/revisions/67cb925f1c81/schema)