Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Notes

List notes

Get paginated list of notes

get/notes

Query parameters

author_user_idstring uuid

Only return notes where the author user ID matches the specified string.

Example:64438afd-fa20-4010-a573-2bbdca77cdb6
related_resource_idstring[]

Only return notes that have a related resource with the specified ID.

idstring[]

Return the note with the specified id. Multiple IDs can be provided as a comma-separated list.

related_resource_type'ACCOUNT' | 'APPLICATION' | 'BILLING' | 'BUSINESS' | 'CUSTOMER' | 'FILE' | 'SHADOW_TRANSACTION' | 'SNAPSHOT' | 'TENANT' | 'TRANSACTION' | 'USER'

Type of the resource associated with the note.

Example:CUSTOMER

Only return notes that have a related resource with the specified type.

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d
limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100
tenantstring

Only return resources owned by the specified tenant

Example:abcdef_ghijkl

Response

List of notes

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "notes": [
    {
      "author": "Jane Smith jane@example.com",
      "content": "Customer was frozen to investigate fraud.",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "related_resource_field": "/legal_address/city",
      "related_resource_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "related_resource_type": "CUSTOMER",
      "status": "RESOLVED",
      "tenant": "abcdef_ghijkl",
      "type": "NOTE"
    }
  ],
  "next_page_token": "a8937a0d"
}