Skip to main content
GET
/
v1
/
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: Bearer <token>'
{
  "items": [
    {
      "channelId": "<string>",
      "channelName": "<string>",
      "email": "<string>",
      "embedTenantName": "<string>",
      "embedUserId": 123,
      "externalId": "<string>",
      "userId": 123,
      "username": "<string>"
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  }
}
🔒 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.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
integer
required

Numeric id of the deployment that owns the notification.

id
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
pageInfo
object