API Reference

Full reference for NexusAPI v3. All requests must include a valid Bearer token unless noted. Base URL: https://api.nexus-gw.io

GET /v3/health No auth required

Returns current service health. No authentication required. Use for uptime monitoring and load balancer health checks.

application/json200 OK

{
  "status": "healthy",
  "version": "3.4.1",
  "uptime_seconds": 2847391,
  "region": "eu-west-1",
  "timestamp": "2025-04-20T10:22:11Z"
}

POST /v3/auth/token Issue access token

Exchange client credentials for a short-lived Bearer token (TTL: 3600s). Tokens are RS256-signed JWTs and must be refreshed before expiry.

Request body

Parameter	Type	Required	Description
client_id	string	required	Your application client ID
client_secret	string	required	Client secret (min 32 chars)
scope	string	optional	Space-separated scopes. Default: `read`
grant_type	string	optional	Default: `client_credentials`

application/json200 OK

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "read write",
  "issued_at": "2025-04-20T10:22:11Z"
}

GET /v3/data/{collection} Paginated list

Retrieve records from a collection. Supports filtering, sorting, and cursor-based pagination.

Query parameters

Parameter	Type	Required	Description
page	integer	optional	Page number (default: 1)
per_page	integer	optional	Records per page, max 500 (default: 50)
filter	string	optional	OData filter expression
sort	string	optional	Field to sort by, prefix - for desc
cursor	string	optional	Pagination cursor token

application/json200 OK

{
  "status": "ok",
  "data": [ { "id": "rec_9f2a1b", "created_at": "2025-04-20T09:14:22Z" }, ... ],
  "meta": {
    "total": 1482, "page": 1, "per_page": 50,
    "cursor_next": "cur_xK9fZj1mQ"
  }
}

Rate limits

Free

requests / hour

Pro

100K

requests / hour

Enterprise

∞

custom SLA