Appearance
Get a patent office and its requirements
GET /api/v2/external/patent-offices/{office}Authentication: x-api-key header, with the patents:read scope. See Authentication and limits.
The fields this office requires before a patent can be managed (requiredFields) and the fields whose change on an existing patent is staged for review (stagedFields). stagedFields applies to updates only: a creation is always staged.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
office | string | Yes | Patent office / authority code, 2 uppercase letters (WO, EP, EA, or an ISO 3166-1 national office code). |
Response
200 The patent office and its requirements.
json
{
"object": "patentOffice",
"office": "EP",
"requiredFields": [
"office",
"patentType",
"filingRoute",
"applicationNumber",
"applicationDate",
"applicantType"
],
"stagedFields": [
"office",
"filingRoute",
"patentType",
"status",
"applicationDate",
"publicationDate",
"grantDate",
"lapseDate",
"expirationDate",
"extendedExpirationDate",
"nationalPhaseEntryDate",
"renewalsManagedFrom",
"applicationNumber",
"publicationNumber",
"grantPublicationNumber",
"pctApplicationNumber"
]
}Response fields
| Field | Type | Description |
|---|---|---|
object | string | String describing the object type (auto-description). One of: patentOffice. |
office | string | Patent office / authority code (WO, EP, EA, or an ISO 3166-1 national office code). |
requiredFields | array of string | Fields this office needs before a patent can be managed. Declarative: a creation is rejected only when it lacks office, patentType, applicationNumber or applicationDate; any other listed field may be missing, the item is still accepted and staged, and the reviewer completes it. |
stagedFields | array of string | Fields whose change on an existing patent is staged for review instead of being applied. Applies to updates only: a creation is always staged. The four patent numbers (applicationNumber, publicationNumber, grantPublicationNumber, pctApplicationNumber) are always in this list. |
Errors
Errors use the application/problem+json envelope with stable machine-readable codes. See the Errors guide.
| Status | Description |
|---|---|
| 400 | Validation failed (validation_failed): carries per-field errors[] with RFC 6901 JSON Pointers. |
| 401 | Missing or invalid API key (invalid_api_key), or expired key (api_key_expired). |
| 403 | API key lacks the required scope (insufficient_scope, with requiredScope extension) or the operation is not enabled for this client (forbidden). |
| 404 | The code is not one of the patent offices Renewr manages. |
| 429 | Daily API call limit exceeded (rate_limit_exceeded): the Retry-After header gives the seconds until reset. |
Example request
bash
curl "https://api.renewr.example/api/v2/external/patent-offices/$OFFICE" \
-H "x-api-key: $RENEWR_API_KEY"