API reference

The public API lives under /v1. Every call carries an agent token issued under Account → API: Authorization: Bearer <token>. No cookie and no origin header: the token is the whole credential.

A token reaches only the operations its scopes name; any other answers 404, exactly as if it did not exist. No token, or an expired or revoked one, answers 401 with WWW-Authenticate.

Each token may make 120 requests a minute. Every answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; past the limit the answer is 429 with Retry-After, the seconds to wait.

The creates that carry the Idempotency-Key badge in this reference (createCase, confirmUpload, createNotification, attachDocument and sendNotification among them) accept that header: a retry with the same key answers the first result instead of creating twice.

Every list pages the same way: _first=<rows> answers { rows, nextCursor, hasMore }, and the next page is asked for with _after=<nextCursor>. On the last page nextCursor is null. A _first above the list's maximum is refused with 400 X_INPUT_INVALID; it is never cut down.

Operations without a /v1 path belong to the panel: they answer a signed-in session and may change without notice. Build integrations on /v1.

Each operation's description is in English: it is what the system itself declares, the same text AI assistants read.

• Quickstart: from a token to a draft notification
• Authentication, scopes and limits
• Idempotent retries
• Errors and codes
• Error catalog: every code, its status and fix
• API changelog
• The OpenAPI document of the /v1 API (JSON)
• MCP server

An affiliate's account has its own API, at https://www.notificado.co/v1/afiliados. Every call carries an affiliate token, created on /afiliados by the approved affiliate: Authorization: Bearer <token>. A firm token reaches nothing there, and an affiliate token reaches nothing of a firm.

Two scopes: affiliate:read reads the summary, the referral link, the verification status, the statements and the ledger, and downloads the support document (the download is recorded); affiliate:invoices uploads and submits a statement's invoice, which waits for the affiliate's confirmation on /afiliados.

Applying and accepting the terms, the verification, the payout account, confirming an invoice, and creating or revoking tokens happen only in person. No operation asks for an affiliate id: the token says who it is.

• The affiliate API guide
• The affiliate operations
• The affiliate API's OpenAPI document (JSON)