List Connect Apps for an account | Sample

4 parameters

AccountSidstringrequired

The account SID whose Connect Apps to list. Must be 34 characters and match the `AC` SID format.

PageSizeintegeroptional

Number of Connect Apps to return per page. Defaults to 50 when omitted and must not exceed 1000.

Pageintegeroptional

The zero-based page index used for client state. Defaults according to the API when omitted.

PageTokenstringoptional

The pagination token provided by the API for retrieving a specific page.

1 status code

200Returns a paginated object containing Connect App resources and page metadata, including page links, page indexes, and page size.

endintegeroptional

first_page_uristringoptional

next_page_uristringoptional

pageintegeroptional

page_sizeintegeroptional

previous_page_uristringoptional

startintegeroptional

uristringoptional

connect_appsarray<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; use the API-provided PageToken to retrieve another page.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: {
    username: process.env.API_USER,
    password: process.env.API_PASS,
  },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.connectAppsJson.list({
  accountSid: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  pageSize: 20,
  page: 1,
  pageToken: "sk_live_4eC39Hq",
});

{
  "connect_apps": [
    {
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "authorize_redirect_url": "http://example.com/redirect",
      "company_name": "Twilio",
      "deauthorize_callback_method": "GET",
      "deauthorize_callback_url": "http://example.com/deauth",
      "description": null,
      "friendly_name": "Connect app for deletion",
      "homepage_url": "http://example.com/home",
      "permissions": [],
      "sid": "CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
    }
  ],
  "end": 0,
  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=0&PageSize=50",
  "next_page_uri": null,
  "page": 0,
  "page_size": 50,
  "previous_page_uri": null,
  "start": 0,
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=0&PageSize=50"
}

Request

Response

Errors