Skip to main content
Get an alert topic

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 agreement.id. id is always returned. Fields: id, agreement, title, description, is_locked, counts, organization_currency, created_at, updated_at, key_questions, evidence.

citation_context
enum<string>

true adds context_before and context_after to document citations: the text around each quote, used to locate it in the document.

Available options:
true,
false

Response

The topic with its alert counts and citations.

id
string<uuid>
required
agreement
object | null
required
title
string | null
required
description
string | null
required
is_locked
boolean
required
counts
object
required

Alerts by verdict, each split into credited and uncredited alerts.

organization_currency
object
required

Impact in the organization currency: the sum of the alerts’ converted impacts.

created_at
string<date-time>
required
updated_at
string<date-time>
required
key_questions
string[]
required
evidence
object
required