list | SignalWire

List number groups in the project.

Query parameters

filter_namestringOptional<=255 characters

Filter by name. Returns all number groups containing this value as a substring.

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

linksobjectRequired

Pagination links.

datalist of objectsRequired

List of number groups.

Response Example

Response

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "My Number Group",
      "sticky_sender": false,
      "phone_number_count": 4
    }
  ]
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});
const result = await client.numberGroups.list();
for (const group of result.data ?? []) {
    console.log(group.name, group.id);
}