list_memberships

List phone numbers that belong to a group.

Path parameters

NumberGroupIdstringRequiredformat: "uuid"

Unique ID of the number group.

Query parameters

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 group memberships.

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       "number_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
12       "phone_number": {
13         "id": "string",
14         "name": "Jenny",
15         "number": "+15558675309",
16         "capabilities": [
17           "voice",
18           "sms",
19           "mms",
20           "fax"
21         ]
22       },
23       "created_at": "2023-01-15T10:30:00Z",
24       "updated_at": "2023-01-15T10:30:00Z"
25     }
26   ]
27 }

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 memberships = client.number_groups.list_memberships("group-id")
10 for m in memberships.get("data", []):
11     print(m.get("phone_number_id"), m.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	"number_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
12	"phone_number": {
13	"id": "string",
14	"name": "Jenny",
15	"number": "+15558675309",
16	"capabilities": [
17	"voice",
18	"sms",
19	"mms",
20	"fax"
21	]
22	},
23	"created_at": "2023-01-15T10:30:00Z",
24	"updated_at": "2023-01-15T10:30:00Z"
25	}
26	]
27	}

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	memberships = client.number_groups.list_memberships("group-id")
10	for m in memberships.get("data", []):
11	print(m.get("phone_number_id"), m.get("id"))