API reference
All operations
NOTE

Fetches notes related to a specific record with pagination.

GET/api/v2/notes/by-record

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

recordTypequerystring

The type of record (Company, Contact, Equipment, etc.)

recordIdqueryinteger · int32

The ID of the record

pagequeryinteger · int32

Page number (default: 1)

pageSizequeryinteger · int32

Number of items per page (default: 20)

Responses

Notes retrieved successfully

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

Paginated
dataPaginatedResponse<NoteDetailsDto[]>
  • totalCountinteger · int32
    • noteIdinteger · int32
    • noteTypestring
    • recordIdinteger · int32
    • recordTypestring
    • userstring
    • noteDatestring · date
    • commentsstring
    • lastModifiedstring · date-timenullable
    • notePurposesstring[]
    • noteResultsstring[]
  • pageCountinteger · int32
  • currentPageCountinteger · int32
  • nextPageNumberinteger · int32nullable
  • hasNextPageboolean