List API Keys for an account | Twilio API (unofficial showcase)

4 parameters

AccountSidstringrequired

The SID of the account whose API Keys to list, in the format `AC` followed by 32 hexadecimal characters.

PageSizeintegeroptional

The number of resources to return per page, from 1 to 1000. Defaults to 50 when omitted.

Pageintegeroptional

The page index used for client state. Must be zero or greater.

PageTokenstringoptional

The page token provided by the API for navigating the results.

1 status code

200Returns a paginated response containing API Key records, including their SIDs, friendly names, creation and update dates, and page navigation metadata.

endintegeroptional

first_page_uristringoptional

next_page_uristringoptional

pageintegeroptional

page_sizeintegeroptional

previous_page_uristringoptional

startintegeroptional

uristringoptional

keysarray<object>optional

Error handling

AccountSid must be a 34-character account SID beginning with AC. PageSize must be between 1 and 1000, and Page must be zero or greater.

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.keysJson.list({
  accountSid: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  pageSize: 20,
  page: 1,
  pageToken: "sk_live_4eC39Hq",
});

{
  "keys": [
    {
      "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "friendly_name": "foo",
      "date_created": "Mon, 13 Jun 2016 22:50:08 +0000",
      "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000"
    }
  ],
  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0",
  "end": 0,
  "previous_page_uri": null,
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0",
  "page_size": 50,
  "start": 0,
  "next_page_uri": null,
  "page": 0
}

Request

Response

Errors