list_memberships | SignalWire

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

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "number_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "phone_number": {
        "id": "string",
        "name": "Jenny",
        "number": "+15558675309",
        "capabilities": [
          "voice",
          "sms",
          "mms",
          "fax"
        ]
      },
      "created_at": "2023-01-15T10:30:00Z",
      "updated_at": "2023-01-15T10:30:00Z"
    }
  ]
}

Example

from signalwire.rest import RestClient
client = RestClient(
    project="your-project-id",
    token="your-api-token",
    host="your-space.signalwire.com",
)
memberships = client.number_groups.list_memberships("group-id")
for m in memberships.get("data", []):
    print(m.get("phone_number_id"), m.get("id"))