Skip to content
KataraKatara documentation

List your notifications

GET
/katara/v1/notifications
curl --request GET \
  --url 'https://api.katara.com/katara/v1/notifications?product=account&state=unread&limit=25' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
org_id
string format: uuid
environment_id
string format: uuid
product
string
Allowed values: account organization billing provider cortex synapse locus
state
string
Allowed values: unread read archived
after
string
<= 128 characters
limit
integer
default: 25 >= 1 <= 100

Header Parameters

Section titled “Header Parameters”
X-Katara-Account-ID
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/

Optional for reads after sign-in. Use the UUID of the account that loaded the application. A different current cookie account returns account_changed before the handler runs. Session bearer and API key clients do not require this header.

Responses

Section titled “Responses”

200

Section titled “200”

Current notification state.

Media typeapplication/json
object
data
required
Array<object>
object
id
required
string format: uuid
event
required
object
id
required
string format: uuid
producer
required
string
Allowed values: account organization billing provider cortex synapse locus
type
required
string
Allowed values: account.security_changed organization.invitation_received organization.membership_changed billing.balance_low billing.payment_failed billing.statement_ready billing.subscription_activated billing.subscription_payment_failed billing.subscription_cancelled billing.subscription_changed provider.health_attention provider.registration_changed provider.payment_updated cortex.usage_limit synapse.run_completed synapse.run_failed synapse.run_cancelled synapse.connection_required synapse.budget_required synapse.evaluation_ready locus.approval_required locus.action_denied locus.connection_revoked locus.access_review_due synapse.ingestion_ready synapse.ingestion_failed synapse.ingestion_unknown synapse.evaluation_failed synapse.evaluation_unknown synapse.online_evaluation_skipped locus.connection_required organization.key_expiring locus.grant_expiring locus.budget_expiring synapse.repository_approval_expiring
schema_version
required
integer
Allowed value: 1
template_version
required
integer
Allowed value: 1
source_operation_id
required
string format: uuid
org_id
string format: uuid
environment_id
string format: uuid
mode
required
string
Allowed values: account test live
resource_type
required
string
Allowed values: account invitation membership billing provider usage run evaluation approval action connection access_review grant budget key repository_approval
resource_id
required
string format: uuid
occurred_at
required
string format: date-time
product
required
string
Allowed values: account organization billing provider cortex synapse locus
category
required
string
Allowed values: security membership billing health usage runs evaluations approvals policy connections access expiry
title
required
string
body
required
string
deep_link
required
string
/^/notifications/[0-9a-f-]{36}$/
state
required
string
Allowed values: unread read archived
version
required
integer
>= 1
created_at
required
string format: date-time
subject

What an expiry notice is about: the name given to the agent grant, budget or API key, or the repository whose approval ends, when it ends, and the portal page where it is renewed. It is read from the source each time the notice is read. Once the object is renewed, revoked or over, the notice is no longer returned.

object
name
required
string
>= 1 characters <= 120 characters
expires_at
required
string format: date-time
path
required

Portal path with the organization and environment in its query.

string
/^/(synapse/runs/new|synapse/repositories|locus/authority|keys)\?/
next_cursor
string
<= 128 characters
Example
{
  "data": [
    {
      "event": {
        "producer": "account",
        "type": "account.security_changed",
        "schema_version": 1,
        "template_version": 1,
        "mode": "account",
        "resource_type": "account"
      },
      "product": "account",
      "category": "security",
      "state": "unread"
    }
  ]
}

400

Section titled “400”

Invalid request.

403

Section titled “403”

A current human session or permission is required.

404

Section titled “404”

Item or source access is unavailable.

409

Section titled “409”

The state version changed; reload before editing.