Responses

Response and error formats for the Stigg REST API

Response format

All responses are returned in JSON format with consistent structure:

Successful response:

{
  "id": "customer-123",
  "name": "Acme Corp",
  "email": "[e-mail]",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Error handling

The API uses standard HTTP status codes and returns detailed error information in a consistent format.

Status	Meaning
200	Success — request completed, body contains the resource
201	Created — resource was successfully provisioned
400	Bad request — invalid parameters or request body
401	Unauthenticated — missing or invalid X-API-KEY
403	Forbidden — authenticated but not authorized for this resource
404	Not found — the specified resource does not exist
409	Conflict — e.g. a subscription already exists for this customer
429	Too many requests — rate limit exceeded; see Rate Limits