For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
      • POSTCreate number group
      • DELDelete number group
      • GETGet number group
      • GETList number groups
      • PUTUpdate number group
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
Phone Number ManagementNumber Groups

List number groups

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/relay/rest/number_groups
GET
/api/relay/rest/number_groups
$curl https://{your_space_name}.signalwire.com/api/relay/rest/number_groups \
>     -u "<project_id>:<api_token>"
1{
2  "links": {
3    "self": "string",
4    "first": "string",
5    "next": "string",
6    "prev": "string"
7  },
8  "data": [
9    {
10      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11      "name": "My Number Group",
12      "sticky_sender": false,
13      "phone_number_count": 4
14    }
15  ]
16}
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).
Was this page helpful?
Previous

Update number group

Next
Built with

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.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Query parameters

filter_namestringOptional<=255 characters
Filter by name. Returns all number groups containing this value as a substring.
page_numberintegerOptionalDefaults to 0
The page number to retrieve.
page_sizeintegerOptional1-1000Defaults to 50
The number of results per page.
page_tokenstringOptional

Token for cursor-based pagination.

Response

The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of number groups.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)