Skip to main content
Read a notification channel

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as delivery_summary.days. id is always returned. Fields: id, type, owner, destination, delivery_summary.

Response

The channel and its destination. Delivery settings are in preferences.

id
string<uuid>
required
type
enum<string>
required
Available options:
email,
slack
owner
enum<string>
required
Available options:
personal,
organization
destination
object
required
delivery_summary
object
required