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.

Query Parameters
filter_name string

The name given to the brand. Will return all Brands containing this value as a substring.

Responses
200

OK

Schema
links object
self string
first string
next string
prev string
data object[]
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

The number of phone numbers within the group.

name string

The name given to the number group. Helps to distinguish different groups within your project.

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.