API Reference

The Renewr External API v2 is a REST API served under a single base path:

https://api.renewr.example/api/v2/external

• Authentication: every request carries your key in the x-api-key header. Keys are scoped; see Authentication & limits.
• Format: JSON in and out (application/json), binary documents as application/pdf. Errors are RFC 9457 application/problem+json.
• Conventions: camelCase fields, UUID path params, decimal-string amounts, ISO 8601 dates; see API conventions.
• Versioning: the version lives in the URL (/v2/). Within v2, changes are additive only: new optional fields, new endpoints, and new enum values may appear at any time, so your integration must ignore unknown fields and tolerate unknown enum values. Removals or renames would only ever happen in a new URL version.

Operations

Patents

Operation	Endpoint
List patents	GET /patents
Get a patent	GET /patents/{patentId}
List the events of a patent	GET /patents/{patentId}/events
Get a patent event	GET /patents/{patentId}/events/{eventId}
Get the fees of an event	GET /patents/{patentId}/events/{eventId}/fees
Download the invoice PDF	GET /patents/{patentId}/events/{eventId}/documents/invoice
Download the instruction receipt PDF	GET /patents/{patentId}/events/{eventId}/documents/instruction-receipt
Download the official receipt PDF	GET /patents/{patentId}/events/{eventId}/documents/official-receipt

Patent events (cross-portfolio)

Operation	Endpoint
List patent events by due period	GET /patent-events

Patent instructions

Operation	Endpoint
Create patent instructions	POST /patent-instructions

Invoices

Operation	Endpoint
List invoices	GET /invoices
Get an invoice	GET /invoices/{invoiceId}

Exchange rate freezes

Operation	Endpoint
List frozen months	GET /exchange-rate-freezes
Get a month freeze	GET /exchange-rate-freezes/{yearMonth}
Freeze a month	PUT /exchange-rate-freezes/{yearMonth}

OpenAPI document

The whole reference is generated from the API's OpenAPI 3.0 document, the same contract the server is built from. You can import it into Postman, Insomnia, Yaak, or your code generator.