Skip to main content

List all 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 must include the following scopes: Numbers.

Query Parameters
filter_name string

The name given to the number group to distinguish different groups within your project. Will return all SIP Endpoints containing this value as a substring.

Responses
200

OK

Schema OPTIONAL
links object OPTIONAL
self string OPTIONAL
first string OPTIONAL
next string OPTIONAL
prev string OPTIONAL
data object[] OPTIONAL
id uuid

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

phone_number_count number OPTIONAL

The number of phone numbers within the group.