list | SignalWire

List addresses in the project.

Query parameters

page_numberintegerOptionalDefaults to 0

The page number to retrieve (0-indexed).

page_sizeintegerOptional1-1000Defaults to 50

The number of items per page (1-1000).

page_tokenstringOptional

Token for cursor-based pagination. Required when page_number > 0.

Response

linksobjectRequired

Pagination links.

datalist of objectsRequired

List of addresses.

Response Example

Response

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       "label": "My Address",
12       "country": "US",
13       "first_name": "Emmett",
14       "last_name": "Brown",
15       "street_number": "1640",
16       "street_name": "Riverside Drive",
17       "address_type": "Apartment",
18       "address_number": "42",
19       "city": "Alexandria",
20       "state": "CA",
21       "postal_code": "91905",
22       "zip_code": "91905"
23     }
24   ]
25 }

Example

1 import { RestClient } from "@signalwire/sdk";
2 
3 const client = new RestClient({
4   project: "your-project-id",
5   token: "your-api-token",
6   host: "your-space.signalwire.com"
7 });
8 
9 const result = await client.addresses.list();
10 for (const addr of result.data ?? []) {
11     console.log(addr.friendlyName, addr.street);
12 }