List OAuth clients

Retrieve a paginated list of OAuth clients for the authenticated user

GET /oauth/clients

JavaScript

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 oauthClient of client.oauthClients.list()) {
  console.log(oauthClient.client_id);
}

200

{
  "data": [
    {
      "record_type": "oauth_client",
      "client_id": "<string>",
      "name": "<string>",
      "org_id": "<string>",
      "user_id": "<string>",
      "client_type": "public",
      "require_pkce": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "allowed_scopes": [
        "<string>"
      ],
      "allowed_grant_types": [
        "client_credentials"
      ],
      "redirect_uris": [
        "<string>"
      ],
      "logo_uri": "<string>",
      "tos_uri": "<string>",
      "policy_uri": "<string>",
      "client_secret": "<string>"
    }
  ],
  "meta": {
    "page_number": 123,
    "page_size": 123,
    "total_results": 123,
    "total_pages": 123
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

page[size] · integer · default: 20

Number of results per page

Required range: 1 <= x <= 100

page[number] · integer · default: 1

Page number

Required range: x >= 1

filter[client_type] · enum<string>

Filter by client type

Available options: confidential, public

filter[verified] · boolean

Filter by verification status

filter[allowed_grant_types][contains] · enum<string>

Filter by allowed grant type

Available options: client_credentials, authorization_code, refresh_token

filter[name] · string

Filter by exact client name

filter[name][contains] · string

Filter by client name containing text

filter[client_id] · string

Filter by client ID

Response

200

application/json

List of OAuth clients

data · object[]

Show child attributes

meta · object

Show child attributes