The OpenAPI document

GEThttps://api.norreach.app/v1/openapi.json

This API as an OpenAPI 3.1 document, generated from the same definitions the server runs. Import it into your tools or generate a client from it.

Any keyOperation id: get_openapi

GET/openapi.json

curl -X GET "https://api.norreach.app/v1/openapi.json" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

The OpenAPI document

{
  "openapi": "3.1.0",
  "info": {
    "title": "NorReach API",
    "version": "1.0.0"
  },
  "paths": {}
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. Any valid key works. API keys and scopes

200application/json— The OpenAPI document

openapi"3.1.0"required

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

GET/openapi.json

curl -X GET "https://api.norreach.app/v1/openapi.json" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

The OpenAPI document

{
  "openapi": "3.1.0",
  "info": {
    "title": "NorReach API",
    "version": "1.0.0"
  },
  "paths": {}
}