Guide
Versioning & changelog
The API is versioned in the URL. The current major version is v1 (release 1.0.0).
These ship in v1 without notice. Build clients that tolerate them:
- New endpoints and new optional parameters.
- New properties in responses. Ignore fields you do not recognize.
- New enum values, object types, field types, and error codes.
- New headers, and changes to the wording of error messages.
- Workspace data model changes: admins can add objects, fields, and workflow statuses at any time. Read the field contract instead of hardcoding it.
Removing or renaming fields or endpoints, changing types, or making optional inputs required only happens in a new major version (/v2). Before that, v1 responses carry Deprecation and Sunset headers, and the change is announced here with a migration guide and notice period.
Initial release of the PRESHos API:
- Workspace: identify the api key, list workspace members, retrieve a member, list teams.
- Schema: list object types, describe an object type, retrieve a status workflow.
- Records: list records, search records, aggregate records, apply a batch of changes atomically, create a record, retrieve a record, update a record, delete a record, change a record's status.
- Relationships: discover a record's relationships, list linked records, link a record, unlink a record.
- Comments: list a record's comments, comment on a record.
- Search: search across objects.
Also: personal API keys with scopes, cursor pagination, idempotency keys, optimistic concurrency, per-key rate limits, and an OpenAPI 3.1 document.