List all Number Groups

GET 
/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.

Request

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

application/json

Schema

Schema

links

object

self string

first string

next string

prev string
data object[]

Example (from schema)

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "My Number Group",
      "sticky_sender": false,
      "phone_number_count": 4
    }
  ]
}