v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

List Notes

This API endpoint retrieves a list of notes on clients or companies in your workspace. <br> You can use the query params to filter a subset of clients or companies that match the specified field values.

get/v1/notes

Query parameters

entityTypestring

Only return notes that have an entity type matching this value. Can be one of client or company.

entityIdstring

Only return notes for the entity (client or company) specified by this ID. If this parameter is included, you must also specify an entity type.

limitinteger

Maximum number of notes to fetch. Default: 20

nextTokenstring

Next token for pagination.

Response

200

nextTokenstring

Example response

{
  "data": [
    {
      "content": "<p>Example content.</p>",
      "createdAt": "2025-03-12T16:09:26Z",
      "creatorId": "2417c06f-44fe-4913-8c84-cd5d358d6f4b",
      "entityId": "9edc4eb8-2b52-454a-bacf-c1d3889a1fbd",
      "entityType": "company",
      "id": "22f09cc7-a28f-453a-b39e-f017e4a79484",
      "object": "note",
      "title": "Example Note 2"
    }
  ],
  "nextToken": "eyJwa2V5IjoiOGY0MzM1ZmQtNzc5Yi00Mzc2LWIwZTUtZTc2ODQ4MjFiZDg3Iiwic2tleSI6Ik5PVEUiLCJkYXRhIjoidXdQbm5HYTlwI0NPTVBBTlkjOWVkYzRlYjgtMmI1Mi00NTRhLWJhY2YtYzFkMzg4OWExZmJkIzIwMjUtMDMtMDRUMTc6MDg6NDAtMDU6MDAifQ=="
}