StatusResponse

The GET /status response. This is the cheapest way to confirm that a token works and that you are talking to the v3 surface.

successbooleanrequired

Always true on this payload.

Example: true

apistringrequired

The API surface that answered. Always v3 on this document's routes.

Possible values: [v3]

versionstringrequired

The version of the v3 API surface. It describes the API itself rather than the deployment serving it, so it changes when the surface changes, not on every release.

Example: 3.0.0

StatusResponse

{
  "success": true,
  "api": "v3",
  "version": "3.0.0"
}