list

List number groups in the project.

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

linksobjectRequired

Pagination links.

datalist of objectsRequired

List of number groups.

Response Example

Response

1 {
2   "links": {
3     "self": "string",
4     "first": "string",
5     "next": "string",
6     "prev": "string"
7   },
8   "data": [
9     {
10       "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11       "name": "My Number Group",
12       "sticky_sender": false,
13       "phone_number_count": 4
14     }
15   ]
16 }

Example

1 from signalwire.rest import RestClient
2 
3 client = RestClient(
4     project="your-project-id",
5     token="your-api-token",
6     host="your-space.signalwire.com",
7 )
8 
9 result = client.number_groups.list()
10 for group in result.get("data", []):
11     print(group["name"], group.get("id"))

1	{
2	"links": {
3	"self": "string",
4	"first": "string",
5	"next": "string",
6	"prev": "string"
7	},
8	"data": [
9	{
10	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11	"name": "My Number Group",
12	"sticky_sender": false,
13	"phone_number_count": 4
14	}
15	]
16	}

1	from signalwire.rest import RestClient
2
3	client = RestClient(
4	project="your-project-id",
5	token="your-api-token",
6	host="your-space.signalwire.com",
7	)
8
9	result = client.number_groups.list()
10	for group in result.get("data", []):
11	print(group["name"], group.get("id"))