Skip to main content

Overview

The Nextoria Hub REST API uses API key authentication for server-to-server integrations and OAuth 2.0 for user-delegated access. All API requests must be made over HTTPS. Base URL:

API Keys

API keys are the recommended authentication method for server-side integrations (webhooks, automation, data exports).

Generating an API Key

  1. Go to Settings → API → New API Key
  2. Give the key a descriptive name (e.g. “Zapier Integration”)
  3. Select scopes (see Scopes below)
  4. Copy the generated key — it is shown only once

Using Your API Key

Pass your API key as a Bearer token in the Authorization header:

Scopes

API keys have access to your entire workspace within their granted scopes. Treat them like passwords — never commit them to source control or share them publicly.

OAuth 2.0

For user-facing integrations (e.g. allowing a third-party app to act on behalf of a specific Nextoria Hub user), use the OAuth 2.0 Authorization Code flow.

Application Registration

Register your OAuth application at Settings → API → OAuth Applications → Register App: After registration, you’ll receive a client_id and client_secret.

Authorization Flow

Step 1: Redirect the user to the authorization endpoint:
Step 2: Exchange the authorization code for a token:
Response:
Step 3: Use the access token in API requests:

Rate Limits

Exceeding the rate limit returns a 429 Too Many Requests response with a Retry-After header indicating when to retry.

Error Responses

All API errors follow a consistent format: