For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
      • POSTCreate number group membership
      • DELDelete number group membership
      • GETGet number group membership
      • GETList number group memberships
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
Phone Number ManagementNumber Group Membership

List number group memberships

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/relay/rest/number_groups/:NumberGroupId/number_group_memberships
GET
/api/relay/rest/number_groups/:NumberGroupId/number_group_memberships
$curl https://{your_space_name}.signalwire.com/api/relay/rest/number_groups/NumberGroupId/number_group_memberships \
>     -u "<project_id>:<api_token>"
1{
2  "links": {
3    "self": "string",
4    "first": "string",
5    "next": "string",
6    "prev": "string"
7  },
8  "data": [
9    {
10      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11      "number_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
12      "phone_number": {
13        "id": "string",
14        "name": "Jenny",
15        "number": "+15558675309",
16        "capabilities": [
17          "voice",
18          "sms",
19          "mms",
20          "fax"
21        ]
22      },
23      "created_at": "2023-01-15T10:30:00Z",
24      "updated_at": "2023-01-15T10:30:00Z"
25    }
26  ]
27}

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.

Was this page helpful?
Previous

Create verified caller ID

Next
Built with

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

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

The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of number group memberships.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)