Endpoint
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The contract ID returned by POST /api/v1/contracts |
Request
Response
Response 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 as saved |
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 |
Error Responses
| Status | Meaning |
|---|---|
401 | Missing or invalid X-API-Key |
404 | Contract not found, or belongs to a different user |
429 | Rate limit exceeded — 100 req/min per key |
List Contracts
Retrieve all contracts on your account.
Run a Check
Use this contract ID to run a schema check.
