v77

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012528701.8 MB

Number Groups

Get number group

Retrieves the details of a number group.

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/{id}

idstring uuid required

Universal Unique Identifier.

Unique ID of the number group.

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

namestring required

The name given to the number group. Helps to distinguish different groups within your project.

sticky_senderboolean required

Whether the number group uses the same 'From' number for outbound requests to a number, or chooses a random one.

phone_number_countinteger required

The number of phone numbers within the group.

{
  "name": "My Number Group",
  "phone_number_count": 4
}