List credentials in a SIP credential list | Twilio API (unofficial showcase)

5 parameters

AccountSidstringrequired

The account SID responsible for the credential list. Must start with AC and contain 32 hexadecimal characters.

CredentialListSidstringrequired

The SID of the credential list whose credentials to retrieve. Must start with CL and contain 32 hexadecimal characters.

PageSizeintegeroptional

Number of credentials to return per page, from 1 to 1000. Defaults to 50 when omitted.

Pageintegeroptional

Zero-based page index for client state.

PageTokenstringoptional

Page token provided by the API to retrieve a particular page.

1 status code

200Returns a paginated response containing credential objects and page navigation metadata.

endintegeroptional

first_page_uristringoptional

next_page_uristringoptional

pageintegeroptional

page_sizeintegeroptional

previous_page_uristringoptional

startintegeroptional

uristringoptional

credentialsarray<object>optional

Error handling

AccountSid must start with AC and CredentialListSid must start with CL; each SID must contain 32 hexadecimal characters after its prefix. PageSize must be between 1 and 1000, and Page must be a non-negative integer.

import { Client } from "@octridev/twilio";

const client = new Client({
  baseUrl: "https://api.twilio.com",
  auth: {
    username: process.env.API_USER,
    password: process.env.API_PASS,
  },
});

const result = await client.credentialsJson.list({
  accountSid: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  credentialListSid: "c0a80123-4567-89ab-cdef-0123456789ab",
  pageSize: 20,
  page: 1,
  pageToken: "sk_live_4eC39Hq",
});

{
  "credentials": [
    {
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "credential_list_sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "Wed, 19 Aug 2015 19:48:45 +0000",
      "date_updated": "Wed, 19 Aug 2015 19:48:45 +0000",
      "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
      "username": "1440013725.28"
    }
  ],
  "end": 0,
  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0",
  "next_page_uri": null,
  "page": 0,
  "page_size": 50,
  "previous_page_uri": null,
  "start": 0,
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json?PageSize=50&Page=0"
}

Request

Response

Errors