These docs are for v1.0.0. Click to read the latest docs for v2.0.0.

v1 - 2025-12-03

by ReadMe GitHub Action
  • Company Custom Field Values: The type field in the request body for PUT /companies/{companyId}/custom-fields/{customFieldId}/value must now match the company custom field definition type. If the provided type does not match, a 400 Bad Request error is returned with error code validation.request.body.schema.typeMismatch.

v1 - 2025-10-15

by ReadMe GitHub Action
  • Add new field types: date, single select and multi select, to the feedback form configurations.

v2 - 2025-12-18

by ReadMe GitHub Action
  • Pagination Added a section about attribute pagination
  • Retrieve entity fixed the examples for specifying fields parameter when getting single entity
  • List entities fixed the examples for specifying fields parameter when listing entities
  • List entities fixed the filtering example when listing entities

v2 - 2025-12-11

by ReadMe GitHub Action
  • Added OAuth scope support to API v2. The API now supports 8 scopes. See the OAuth2 documentation for the full list of supported scopes and their descriptions.