Skip to main content

Retrieve a Number Group

GET 
/number_groups/:id

Retrieves the details of a Number Group that has been previously created. Use the unique ID that was returned from your previous request to identify the specific Number Group.

Permissions​

The API token must include the following scopes: Numbers.

Request​

Path Parameters

    id uuidrequired

    Unique ID of the number group

Responses​

OK

Schema

    id uuidrequired

    The unique identifier of the Number Group on SignalWire. This can be used to update or delete the group programmatically.

    name stringrequired

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

    sticky_sender boolean

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

    phone_number_count number

    The number of phone numbers within the group.

Loading...