Changelog

Added

v1 - 2025-12-18 - Introduce PageCursor

7 days ago by ReadMe GitHub Action

Added PageCursor for Companies, Users and Company Fields list endpoints for better performance.

Added

7 days ago by ReadMe GitHub Action

Added PageCursor for Companies, Users and Company Fields list endpoints for better performance.

Improved

7 days ago 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

Added

8 days ago by ReadMe GitHub Action

Added

8 days ago by ReadMe GitHub Action

Added

10 days ago by ReadMe GitHub Action

Added Companies and Users and entity types to Entities API endpoints. Currently those are available only to customers participating in the closed beta program.

Added

14 days ago 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.

Improved

27 days ago by ReadMe GitHub Action

All entity endpoints: removed user and company from the supported entity types enum
Retrieve relationships: renamed the terminology used to refer to entities from "type": "hierarchyItem" to the types used in the entities endpoints. For example, when a note is related to a feature, the response will now show "type": "feature" instead of "type": "hierarchyItem"
Added more documentation to explain the configuration endpoints

Improved

about 1 month ago by ReadMe GitHub Action

Renamed 'Get configurations for all entities' to 'List entity configurations'
List entity configurations: renamed type parameter to type[] to allow for generating valid cURL requests
List entity configurations: added example requests
Retrieve relationships: removed unused type and targetId query parameters
Retrieve relationships: added pageCursor query parameter
Retrieve relationships: consolidated request examples to a single one

Added

9 months ago by ReadMe GitHub Action

Fix updating metadata for all types of Notes. Content can be updated only for simple notes.