List all Access IP Addresses

GET /access_ip_address

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const accessIPAddressResponse of client.accessIPAddress.list()) {
  console.log(accessIPAddressResponse.id);
}

200

{
  "data": [
    {
      "id": "<string>",
      "ip_address": "<string>",
      "source": "<string>",
      "status": "pending",
      "user_id": "<string>",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page_number": 123,
    "page_size": 123,
    "total_pages": 123,
    "total_results": 123
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter · object

Consolidated filter parameter (deepObject style). Originally: filter[ip_source], filter[ip_address], filter[created_at]. Supports complex bracket operations for dynamic filtering.

Show child attributes

page · object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Show child attributes

Response

200

application/json

Successful Response

data · AccessIPAddressResponseSchema · object[] · required

Show child attributes

meta · PaginationMeta · object · required

Show child attributes