Skip to main content
GET
/
telephony_credentials
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 telephonyCredential of client.telephonyCredentials.list()) {
  console.log(telephonyCredential.id);
}
{
  "data": [
    {
      "id": "c215ade3-0d39-418e-94be-c5f780760199",
      "record_type": "credential",
      "name": "2020-06-18 21:32:38.917732Z",
      "expired": false,
      "user_id": "user-id",
      "resource_id": "connection:804252963366242252",
      "sip_password": "a92dbcfb60184a8cb330b0acb2f7617b",
      "sip_username": "gencrednCvHU5IYpSBPPsXI2iQsDX",
      "created_at": "2020-06-18T21:32:38",
      "expires_at": "2042-06-18T21:32:38",
      "updated_at": "2020-06-18T21:32:38.000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
object

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

​
filter
object

Consolidated filter parameter (deepObject style). Originally: filter[tag], filter[name], filter[status], filter[resource_id], filter[sip_username]

Response

Successful response with multiple credentials

​
data
On-demand Credential · object[]
​
meta
object