API Overview (dummy)

Our API follows REST conventions with a few deliberate deviations.

Base URL

All endpoints live under a single versioned prefix:

https://api.example.com/v1

We bump v1 only for breaking changes. Additive changes never require a new version.

Resources

The primary resources are:

• users
• projects
• documents
• events

Each supports the standard verbs: GET (list/read), POST (create), PATCH (update), DELETE (remove).

Pagination

Lists use cursor pagination. A response looks like:

{
  "data": [...],
  "next_cursor": "eyJpZCI6..."
}

Pass next_cursor as a query parameter to get the next page. No cursor means you’re at the end.

Errors

Errors are JSON with a code and message. Never parse message — it is human-readable and may change. Always branch on code.