List notification recipients

GET /v1/deployments/{deploymentId}/notifications/{id}/recipients

List notification recipients

cURL

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

import requests

url = "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications/{id}/recipients"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications/{id}/recipients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications/{id}/recipients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications/{id}/recipients"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications/{id}/recipients")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications/{id}/recipients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "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>"
  }
}

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

Show child attributes

pageInfo · object | null

Show child attributes