Number Groups
List 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 used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.
Learn more about API scopes.
get/api/relay/rest/number_groups
Query parameters
filter_namestring
Filter by name. Returns all number groups containing this value as a substring.
page_numberinteger
The page number to retrieve.
page_sizeinteger
The number of results per page.
page_tokenstring
Token for cursor-based pagination.
Response
The request has succeeded.
Example response
{
"data": [
{
"name": "My Number Group",
"phone_number_count": 4
}
]
}