Sequences

Per-tenant monotonic sequence generators

Method	Path	Summary
GET	/v1/sequences	List sequences
POST	/v1/sequences	Create a sequence
GET	/v1/sequences/{name}	Get a sequence by name
PATCH	/v1/sequences/{name}	Update a sequence
DELETE	/v1/sequences/{name}	Delete a sequence
POST	/v1/sequences/{name}/bump	Bump (advance) a sequence by its step

GET/v1/sequences

List sequences

Param	In	Type	Required	Description
cursor	query	string	No	—
limit	query	integer	No	—

Responses

200Page of sequences

object

401Missing, malformed, or invalid API key

ErrorEnvelope

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key",
    "details": {}
  }
}

POST/v1/sequences

Create a sequence

Request body — object

{
  "name": "orderNo",
  "type": "number",
  "start": 1000,
  "step": 1
}

Responses

201Sequence created

SequenceDto

{
  "tenantId": "tenant-acme-01",
  "name": "orderNo",
  "type": "number",
  "currentValue": 1000,
  "start": 1000,
  "step": 1,
  "createdAt": "2026-07-23T09:00:00.000Z",
  "updatedAt": "2026-07-23T09:00:00.000Z"
}

400Validation or template/generation error

ErrorEnvelope

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "\"name\" is required",
    "details": {
      "field": "name"
    }
  }
}

401Missing, malformed, or invalid API key

ErrorEnvelope

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key",
    "details": {}
  }
}

GET/v1/sequences/{name}

Get a sequence by name

Param	In	Type	Required	Description
name	path	string	Yes	—

Responses

200Sequence

SequenceDto

401Missing, malformed, or invalid API key

ErrorEnvelope

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key",
    "details": {}
  }
}

404Resource does not exist

ErrorEnvelope

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Template tpl_missing not found",
    "details": {}
  }
}

PATCH/v1/sequences/{name}

Update a sequence

Param	In	Type	Required	Description
name	path	string	Yes	—

Request body — object

{
  "currentValue": 2000
}

Responses

200Updated sequence

SequenceDto

401Missing, malformed, or invalid API key

ErrorEnvelope

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key",
    "details": {}
  }
}

404Resource does not exist

ErrorEnvelope

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Template tpl_missing not found",
    "details": {}
  }
}

DELETE/v1/sequences/{name}

Delete a sequence

Param	In	Type	Required	Description
name	path	string	Yes	—

Responses

204Deleted, no content

401Missing, malformed, or invalid API key

ErrorEnvelope

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key",
    "details": {}
  }
}

404Resource does not exist

ErrorEnvelope

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Template tpl_missing not found",
    "details": {}
  }
}

POST/v1/sequences/{name}/bump

Bump (advance) a sequence by its step

Param	In	Type	Required	Description
name	path	string	Yes	—

Responses

200Sequence after bump

SequenceDto

{
  "tenantId": "tenant-acme-01",
  "name": "orderNo",
  "type": "number",
  "currentValue": 1001,
  "start": 1000,
  "step": 1,
  "createdAt": "2026-07-23T09:00:00.000Z",
  "updatedAt": "2026-07-23T09:06:00.000Z"
}

401Missing, malformed, or invalid API key

ErrorEnvelope

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key",
    "details": {}
  }
}

404Resource does not exist

ErrorEnvelope

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Template tpl_missing not found",
    "details": {}
  }
}