List notification recipients

curl --request GET \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications/{id}/recipients \
  --header 'Authorization: <api-key>'

{
  "items": [
    {
      "channelId": "<string>",
      "channelName": "<string>",
      "email": "<string>",
      "embedTenantName": "<string>",
      "embedUserId": 123,
      "externalId": "<string>",
      "userId": 123
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  }
}

Notifications

List notification recipients

🔒 Admin only. Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.

Returns the recipients subscribed to a notification, cursor-paginated and ordered by creation time (newest first). Recipients span three kinds, distinguished by type: USER (a main console user, with userId + email), EMBED_USER (an embed user, with embedUserId, embedTenantName, externalId, and email), and SLACK (a channel, with channelId + channelName). Returns 404 if the notification is not part of this deployment.

GET

deployments

{deploymentId}

notifications

{id}

recipients

List notification recipients

curl --request GET \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications/{id}/recipients \
  --header 'Authorization: <api-key>'

{
  "items": [
    {
      "channelId": "<string>",
      "channelName": "<string>",
      "email": "<string>",
      "embedTenantName": "<string>",
      "embedUserId": 123,
      "externalId": "<string>",
      "userId": 123
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  }
}

Authorizations

Authorization

string

header

required

API key authentication. Send Authorization: Api-Key <YOUR_API_KEY>.

Path Parameters

deploymentId

integer

required

Numeric id of the deployment that owns the notification.

integer

required

Numeric id of the notification (scheduled run).

Query Parameters

first

any

Page size for cursor pagination (default 100, max 200).

after

any

Opaque cursor for the next page; pass the previous response's pageInfo.endCursor.

Response

200 - application/json

items

object[]

required

Show child attributes

pageInfo

object

Show child attributes

Delete a scheduled notification Add notification recipients

⌘I