OAuth2

Get All Clients

Owned OAuth clients for the user. Does not include the auto-managed default subscription client (same omission as GET /apps).

get/oauth/clients

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/oauth/clients
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Response

namestring required

The name of the client

descriptionstring

The description of the client

client_idstring required

The client ID

client_secretstring

The client secret

grant_typesnumber required

The grants of the client

redirect_urisstring[] required

The redirect URIs of the client

scope'admin' | 'identity' | 'profile:read' | 'profile:write' | 'channels:read' | 'channels:write' | 'channels:join' | 'channels:history' | 'mcp:read' | 'mcp:write' | 'cv:read' | 'cv:write' | 'https://www.googleapis.com/auth/calendar.readonly' | 'https://www.googleapis.com/auth/calendar' | 'https://www.googleapis.com/auth/gmail.readonly' | 'https://www.googleapis.com/auth/gmail.modify' | 'https://www.googleapis.com/auth/gmail.send' | 'slack:read' | 'slack:write' | 'microsoft:graph:read' | 'microsoft:graph:write' | 'github:read' | 'github:write' | 'notion:read' | 'notion:write' required

The scopes of the client (space-separated)

client_uristring

The client URI

created_atstring date-time required

The created at date

updated_atstring date-time required

The updated at date

access_token_lifetime_secondsnumber required

Access token lifetime in seconds

refresh_token_lifetime_secondsnumber required

Refresh token lifetime in seconds

webhook_urlstring

The webhook URL of the client

webhooks_url_mode'one_per_client' | 'one_per_subscription'

Defines whether the app uses one webhook URL for the whole client or one webhook URL per subscription. Omit on create/update unless you need a non-default mode; when absent on the stored client, the effective mode is one_per_client.

webhook_authentication_headerobject

The webhook authentication header of the client. Will be used as the authentication header when sending webhooks to the webhook URL

is_default_subscription_clientboolean

When true, this client is the default portal app for webhook subscriptions (one webhook URL per subscription).

Changes

No recorded changes to this operation across all 1 revision of this API.