Skip to navigation

List number groups

View as MarkdownOpen in Claude

Lists the Number Groups in your SignalWire project. A Number Group organizes owned phone numbers into a sender pool and can preserve the same sender for repeated outbound traffic with sticky_sender. Use List number group memberships to see which numbers belong to a group. Results are sorted by creation date, most recent first.

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.
datalist of objects
List of number groups.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error