Sign in
Number Group Membership

Get number group membership

Retrieves one Number Group Membership by ID so you can inspect the link between a project phone number and its sender pool. Use List number group memberships to discover memberships for a 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_group_memberships/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the number group membership.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

number_group_idstring uuid required

Universal Unique Identifier.

created_atstring required

The date and time when the membership was created.

updated_atstring required

The date and time when the membership was last updated.

Example response

{
  "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"
}

Changes

No changes found, but 3 of the 161 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.