v77

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012528701.8 MB
Number Group Membership

List number group memberships

Returns a list of phone numbers in a number group.

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/{NumberGroupId}/number_group_memberships

Path parameters

NumberGroupIdstring uuid required

Universal Unique Identifier.

Unique ID of the number group.

Query parameters

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": [
    {
      "phone_number": {
        "name": "Jenny",
        "number": "+15558675309",
        "capabilities": [
          "voice",
          "sms",
          "mms",
          "fax"
        ]
      },
      "created_at": "2023-01-15T10:30:00Z",
      "updated_at": "2023-01-15T10:30:00Z"
    }
  ]
}