Apps

List owned subscriptions

List subscriptions for this user. Any authenticated user (including agents via session, PAT, or stateless agent JWT) sees only their own rows.

get/apps/subscriptions

Request

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

Query parameters

skipnumber
limitnumber nullable

Max number of results allowed per page is: 100

direction'older' | 'newer' nullable
datestring

ISO 8601 date string for cursor pagination

Response

total_resultsnumber required

Example response

{
  "results": [
    {
      "subscriptions": [
        "message.initializing",
        "message.started",
        "message.paused",
        "message.resumed",
        "message.offline",
        "message.processing",
        "message.finished",
        "message.deleted",
        "message.discussion-notes.added",
        "message.label.added",
        "message.attachment.added",
        "message.attachment.uploaded",
        "message.posted.to.channel",
        "message.voicememo.created",
        "channel.created",
        "channel.deleted",
        "channel.user.joined",
        "channel.users.added",
        "channel.user.left",
        "channel.user.removed",
        "channel.async-check.mid",
        "channel.async-check.ending",
        "channel.async.ended",
        "channel.async.extended",
        "channel.async.shortened",
        "channel.ai-summary.generated",
        "workspace.user.joined",
        "workspace.user.added",
        "workspace.user.left",
        "workspace.user.removed",
        "workspace.findable-channel.created",
        "ai.prompt.response.generated",
        "action-item.created",
        "action-item.updated",
        "action-item.deleted",
        "action-item.status.changed",
        "ask.answered"
      ],
      "subscription_filters": [
        {
          "key": "name",
          "operator": "eq"
        }
      ],
      "subscription_actions": [
        {
          "action_id": "run_ai_prompt",
          "entity_type": "ai_prompt",
          "metadata": {
            "conversation_id": "channel_123",
            "send_as_bot": true,
            "message": "Daily standup reminder!",
            "links": [
              "https://pxassets.s3.us-east-2.amazonaws.com/images/v2/logo.png",
              "https://pxassets.s3.us-east-2.amazonaws.com/images/v2/Personal+CarbonLink.svg",
              "https://www.youtube.com/watch?v=36Tn5cektlg"
            ]
          }
        }
      ]
    }
  ]
}

Changes

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