Retrieve a Number Group

GET 
/number_groups/:id

Retrieves the details of a Number Group that has been previously created. Use the unique ID that was returned from your previous request to identify the specific Number Group.

Permissions

The API token must include the following scopes: Numbers.

Request

Path Parameters

id uuidrequired

Unique ID of the number group

Responses

200

OK

application/json

Schema

Schema

id uuidrequired

The unique identifier of the Number Group on SignalWire. This can be used to update or delete the group programmatically.

name stringrequired
The name given to the number group. Helps to distinguish different groups within your project.
Example: My Number Group
sticky_sender boolean
Whether the number group uses the same 'From' number for outbound requests to a number, or chooses a random one. Defaults to false.
Example: false
phone_number_count number
The number of phone numbers within the group.
Example: 4

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "My Number Group",
  "sticky_sender": false,
  "phone_number_count": 4
}