Apps

Get List of My Apps

Apps that the user has access to (subscribed or not). If the user is the owner of the app, details will be returned with the private fields. Does not include the auto-managed default subscription app (POST /apps/subscribe); that client cannot be listed here or edited via OAuth client APIs.

get/apps

Request

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

Response

idstring required

The primary key of the resource.

namestring required
descriptionstring
client_idstring required
client_secretstring
access_token_lifetime_secondsnumber

Access token lifetime in seconds

refresh_token_lifetime_secondsnumber

Refresh token lifetime in seconds

allowed_callback_urlsstring

Allowed callback URLs (comma separated list)

webhooks_urlstring

Webhook URL to send the data (comma separated list)

webhooks_authentication_headerobject

Authentication header configuration for webhooks. Key-value pairs where both key and value are strings.

allowed_logout_urlsstring

Allowed logout URLs (comma separated list)

created_atstring date-time required

Created at

updated_atstring date-time required

Updated at

deleted_atstring date-time

Deleted at

webhooks_url_mode'one_per_client' | 'one_per_subscription' required

Webhook URL mode

owner_idstring
user_is_subscribed_with_valid_tokensboolean required

Indicates whether the user is subscribed to the app and has valid authentication tokens (access or refresh).

image_urlstring

Image URL

is_default_subscription_clientboolean

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

Example response

[
  {
    "webhooks_authentication_header": {
      "x-api-key": "kNp7vXmL9RqWcYtH2sBnE4aD8fGjK3hU5xZwQ6yVcM1iPuA9nTbS7vFrL4mCxJoN"
    }
  }
]

Changes

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