Skip to Content
DocsREST APIV2Overview

Overview

All API v2 endpoints share the /api/v2/ prefix.

Successful responses use a 2xx HTTP status code and contain resource-specific JSON. A 204 No Content response has no body.

Error responses use a common structure:

{ "code": "no_permission", "message": "You have no permission to perform this action" }

Use the HTTP status to detect failure and message for display.

HTTP statusMeaning
200 / 201 / 202 / 204Success / Created / Accepted / No content
400Malformed request, JSON, or authentication header
401Missing, invalid, or expired authentication
403Insufficient permissions
404Resource not found
405Method not allowed
409Resource or revision conflict
412 / 428Precondition failed / Required precondition missing
413 / 415Request too large / Unsupported media type
422Validation failed
429Too many outstanding login tickets
500 / 503Unexpected server error / Service unavailable
Last updated on