List authorized Connect Apps | Sample

4 parameters

AccountSidstringrequired

The 34-character SID of the account whose authorized Connect Apps to list. Must match the `AC` account SID format.

PageSizeintegeroptional

Number of resources to return per page. Must be between 1 and 1000, and defaults to 50 when omitted.

Pageintegeroptional

Page index used for client state. Must be zero or greater when supplied.

PageTokenstringoptional

API-provided token used to retrieve a subsequent page of results.

1 status code

200Returns a paginated response containing authorized Connect Apps and page metadata, including the current page, page size, resource range, navigation URIs, and collection URI.

endintegeroptional

first_page_uristringoptional

next_page_uristringoptional

pageintegeroptional

page_sizeintegeroptional

previous_page_uristringoptional

startintegeroptional

uristringoptional

authorized_connect_appsarray<object>optional

Error handling

AccountSid must be a 34-character SID matching the AC account pattern. PageSize must be between 1 and 1000, and Page must be zero or greater when supplied; use the API-provided PageToken to request a subsequent 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.authorizedConnectAppsJson.list({
  accountSid: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  pageSize: 20,
  page: 1,
  pageToken: "sk_live_4eC39Hq",
});

{
  "authorized_connect_apps": [
    {
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "connect_app_company_name": "aaa",
      "connect_app_description": "alksjdfl;ajseifj;alsijfl;ajself;jasjfjas;lejflj",
      "connect_app_friendly_name": "aaa",
      "connect_app_homepage_url": "http://www.google.com",
      "connect_app_sid": "CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "permissions": [
        "get-all"
      ],
      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
    }
  ],
  "end": 0,
  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50",
  "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=2&PageSize=50",
  "page": 0,
  "page_size": 50,
  "previous_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=1&PageSize=50",
  "start": 0,
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50"
}

Request

Response

Errors