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

Get number group

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/relay/rest/number_groups/:id
GET
/api/relay/rest/number_groups/:id
$curl https://{your_space_name}.signalwire.com/api/relay/rest/number_groups/id \
>     -u "<project_id>:<api_token>"
1{
2  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3  "name": "My Number Group",
4  "sticky_sender": false,
5  "phone_number_count": 4
6}

Retrieves the details of a number group.

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.

Was this page helpful?
Previous

List number groups

Next
Built with

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)

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the number group.

Response

The request has succeeded.
idstringformat: "uuid"
The unique identifier of the Number Group on SignalWire. This can be used to update or delete the group programmatically.
namestring
The name given to the number group. Helps to distinguish different groups within your project.
sticky_senderboolean
Whether the number group uses the same 'From' number for outbound requests to a number, or chooses a random one.
phone_number_countinteger
The number of phone numbers within the group.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error