PRESHos API v1.0.0
Build on PRESHos
One REST API for every object in a PRESHos workspace: CRM records, work items, catalogs, and each workspace's own custom objects and fields. Discover the data model at runtime, then read, search, and write records with the same endpoints, always as the user who owns the key.
https://api.dev.preshos.com/v1Step 1: Create an API key
In PRESHos, open Settings → Developer and choose Create API key. Pick the Read only preset to start. Copy the key: it is shown once. No Developer page? Ask a workspace admin for developer access. Learn more
Shell export PRESHOS_API_KEY="preshos_v1_…"Step 2: Check the key
GET /v1/mereturns the user the key acts as, the workspace, and the key's scopes.Shell curl https://api.dev.preshos.com/v1/me \ -H "Authorization: Bearer $PRESHOS_API_KEY"Step 3: List objects, then records
Discover the workspace's object types, inspect one object's fields, then list its records.
Shell curl https://api.dev.preshos.com/v1/objects \ -H "Authorization: Bearer $PRESHOS_API_KEY" curl https://api.dev.preshos.com/v1/objects/companies \ -H "Authorization: Bearer $PRESHOS_API_KEY" curl -G https://api.dev.preshos.com/v1/objects/companies/records \ -H "Authorization: Bearer $PRESHOS_API_KEY" \ --data-urlencode "fields=name,domain" \ --data-urlencode "limit=10"Next: filter and paginate or create and update records.
- AuthenticationPersonal API keys, developer access, scopes, and keeping keys safe.
- Objects & recordsDiscover a workspace's data model and the shape of every record.
- QueryingFilters, sorting, field selection, search, aggregates, and pagination.
- Writing dataCreate, update, status changes, concurrency, idempotency, batches, links, and comments.
- ErrorsThe error envelope, every error code, and when to retry.
- Rate limitsPer-key limits, rate-limit headers, and handling 429s.
- Versioning & changelogHow the API evolves, what counts as breaking, and release history.
- MCP & AI toolsHow the API maps onto MCP tools and what is planned next.
Paths are relative to https://api.dev.preshos.com/v1. Every endpoint is documented in the API reference.
Workspace
The API key's identity, workspace members, and teams.
Schema
Discover object types, fields, relationships, and workflows for this workspace.
Records
Create, read, update, delete, search, aggregate, and batch-edit records of any object type.
- GET
/v1/objects/{object_type}/recordsList records - POST
/v1/objects/{object_type}/records/searchSearch records - POST
/v1/objects/{object_type}/records/aggregateAggregate records - POST
/v1/objects/{object_type}/records/batchApply a batch of changes atomically - POST
/v1/objects/{object_type}/recordsCreate a record - GET
/v1/objects/{object_type}/records/{record_id}Retrieve a record - PATCH
/v1/objects/{object_type}/records/{record_id}Update a record - DELETE
/v1/objects/{object_type}/records/{record_id}Delete a record - POST
/v1/objects/{object_type}/records/{record_id}/statusChange a record's status
Relationships
Discover and traverse relationships; link and unlink records.
- GET
/v1/objects/{object_type}/records/{record_id}/relationshipsDiscover a record's relationships - GET
/v1/objects/{object_type}/records/{record_id}/relationships/{association_id}List linked records - POST
/v1/objects/{object_type}/records/{record_id}/relationships/{association_id}Link a record - DELETE
/v1/objects/{object_type}/records/{record_id}/relationships/{association_id}/{target_id}Unlink a record
Comments
Read and post record comments.