Endpoint
Request
Response
Response Fields
Each object in the array has the following fields:| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the contract |
name | string | The name given to the contract |
version | integer | Current version number — increments each time the contract schema is updated |
schema.columns | array | Full list of column definitions |
schema.columns[].name | string | Column name (case-sensitive) |
schema.columns[].type | string | Column type — one of string, integer, number, boolean, date, timestamp, json |
schema.columns[].required | boolean | Whether the column must be present in every check |
created_at | string | ISO 8601 timestamp of when the contract was created |
updated_at | string | ISO 8601 timestamp of the last update |
Results are scoped to your account — you will only ever see contracts created
with your API key. Pagination support is planned for a future release.
Error Responses
| Status | Meaning |
|---|---|
401 | Missing or invalid X-API-Key |
429 | Rate limit exceeded — 100 req/min per key |
Create Contract
Define a new expected schema as a contract.
Get Contract
Retrieve a single contract by its ID.
