API overview

The conventions that apply across the NexArc API — base path, error format, and pagination.

Base path

All endpoints are served under /api/v1. Requests and responses are JSON.

Errors share a consistent shape so clients can handle them uniformly:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "details": { }
  }
}

List endpoints paginate with page and per_page query parameters.

Codes you'll see

Every error code is documented, with its meaning and fix, in the error-codes reference.

Next steps

Last updated: June 2026 · Suggest an edit