REST API

Base URL: https://api.hermios.app/rest. Objects use their plural API name (companies, people, opportunities, dealReviews, …).

Routes

Method and path	Does
`GET /rest/{objects}`	List records
`GET /rest/{objects}/{id}`	Get one record
`POST /rest/{objects}`	Create one record (`?upsert=true` to update a match instead)
`POST /rest/batch/{objects}`	Create up to 200 records
`PATCH /rest/{objects}/{id}`	Update one record (`PUT` also works)
`PATCH /rest/{objects}?filter=...`	Update every record matching the filter
`DELETE /rest/{objects}/{id}`	Delete one record (see below)
`PATCH /rest/{objects}/{id}/restore`	Restore a soft-deleted record
`PATCH /rest/{objects}/merge`	Merge duplicates
`POST /rest/{objects}/duplicates`	Find likely duplicates
`GET /rest/{objects}/groupBy`	Grouped counts and aggregates

DELETE permanently destroys the record unless you add ?soft_delete=true. Soft-deleted records go to the trash and can be restored.

Filtering

filter=field[operator]:value

# Companies with more than 50 employees created this year
curl -G "https://api.hermios.app/rest/companies" \
  -H "Authorization: Bearer $HERMIOS_API_KEY" \
  --data-urlencode 'filter=and(employees[gt]:50,createdAt[gte]:"2026-01-01")'

Operators: eq, neq, in, containsAny, is (NULL / NOT_NULL), gt, gte, lt, lte, startsWith, endsWith, like, ilike. Combine with and(...), or(...) and not(...). Several comma-separated conditions without a wrapper are combined with and. Composite fields use a dot path, for example name.firstName[ilike]:"%ada%" or emails.primaryEmail[eq]:"ada@acme.com".

Sorting

order_by=field[Direction],otherField[Direction], with AscNullsFirst (default), AscNullsLast, DescNullsFirst or DescNullsLast. id is always added as a final tiebreaker so pages are stable.

Pagination

Parameter	Meaning
`limit`	Records per page. Default 60, maximum 200 (higher values are reduced to 200).
`starting_after`	Cursor: return records after this one (`pageInfo.endCursor`).
`ending_before`	Cursor: return records before this one (`pageInfo.startCursor`).

{
  "data": { "companies": [] },
  "totalCount": 312,
  "pageInfo": { "hasNextPage": true, "startCursor": "…", "endCursor": "…" }
}

depth=0 (default) returns the record’s own fields and relation ids. depth=1 also returns related records one level deep (up to 60 per relation). There is no field-selection parameter: use GraphQL when you need specific fields.

Responses

Call	Shape
List	`{ data: { companies: [...] }, totalCount, pageInfo }`
Get	`{ data: { company: {...} } }`
Create	`{ data: { createCompany: {...} } }` (batch: `createCompanies`)
Update	`{ data: { updateCompany: {...} } }`
Delete	`{ data: { deleteCompany: {...} } }`

OpenAPI

Every workspace has its own OpenAPI 3 document:

GET https://api.hermios.app/rest/open-api/core (records)
GET https://api.hermios.app/rest/open-api/metadata (data model)

Send your API key to get your workspace’s objects and fields. Without a token you get the base schema. Import the document into Postman, Insomnia or a code generator.

Data model over REST

GET /rest/metadata/objects lists objects and fields, including custom ones. Creating or changing objects and fields needs a role with data model permission.

Get started

APIs

Reference

Routes

Filtering

Sorting

Responses

OpenAPI

Data model over REST

​Routes

​Filtering

​Sorting

​Pagination

​Related records

​Responses

​OpenAPI

​Data model over REST

Routes

Filtering

Sorting

Pagination

Related records

Responses

OpenAPI

Data model over REST