---
title: "List number groups"
method: GET
path: "/api/relay/rest/number_groups"
tags: ["Number Groups"]
---

# List number groups

`GET /api/relay/rest/number_groups`

Returns a list of your Number Groups. The groups are returned sorted
by creation date, with the most recent appearing first. The list is
filterable by sending in any of the following parameters.

#### Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Numbers_.

[Learn more about API scopes](/docs/platform/your-signalwire-api-space).

## Query parameters

- `filter_name` string
- `page_number` integer
- `page_size` integer
- `page_token` string

## Response `200`

The request has succeeded.

- NumberGroupListResponse — Response containing a list of number groups.
  - `links` PaginationLinks, required — Pagination links for list responses.
    - `self` string, required — Link to the current page.
    - `first` string, required — Link to the first page.
    - `next` string — Link to the next page. Only present when there are more results.
    - `prev` string — Link to the previous page. Only present when not on the first page.
  - `data` NumberGroup[], required — List of number groups.
    - `id` string, uuid, required — Universal Unique Identifier.
    - `name` string, required — The name given to the number group. Helps to distinguish different groups within your project.
    - `sticky_sender` boolean, required — Whether the number group uses the same 'From' number for outbound requests to a number, or chooses a random one.
    - `phone_number_count` integer, required — The number of phone numbers within the group.

## Other responses

- `401` — Access is unauthorized.
- `422` — The request failed validation. See errors for details.
- `500` — An internal server error occurred.

---

[API](https://skmtc.net/signalwire/apis/signalwire-rest-api.md) · [All operations](https://skmtc.net/signalwire/apis/signalwire-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/signalwire/signalwire-rest-api/versions/05c5164b85c7/schema)