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

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "label": "My Address",
      "country": "US",
      "first_name": "Emmett",
      "last_name": "Brown",
      "street_number": "1640",
      "street_name": "Riverside Drive",
      "address_type": "Apartment",
      "address_number": "42",
      "city": "Alexandria",
      "state": "CA",
      "postal_code": "91905",
      "zip_code": "91905",
      "emergency_enabled": false,
      "validated": false,
      "validated_at": null
    }
  ]
}

Example

from signalwire.rest import RestClient
client = RestClient(
    project="your-project-id",
    token="your-api-token",
    host="your-space.signalwire.com",
)
result = client.addresses.list()
for addr in result.get("data", []):
    print(addr.get("friendly_name"), addr.get("street"))