API reference
All operations
NOTE

Fetches a list of notes based on the provided query parameters.

GET/api/v2/notes

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

FromDatequerystring · date
ToDatequerystring · date
Commentsquerystring
ContactIdqueryinteger · int32
UserIdqueryinteger · int32
PageSizequeryinteger · int32
PageNumberqueryinteger · int32

Responses

Notes retrieved successfully.

Standard response envelopeisSuccessmessageerrorsdata

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

Paginated
dataPagedQueryResult<GetNoteDto>
    • noteIdinteger · int32
    • noteTypestring
    • recordIdinteger · int32
    • recordTypestring
    • recordDisplaystring
    • userstring
    • userIdinteger · int32
    • typeIdinteger · int32
    • noteDatestring · date
    • commentsstring
    • latitudenumber · double
    • longitudenumber · double
    • lastModifiedstring · date-timenullable
    • deletedboolean
    • notePurposesstring[]nullable
    • noteResultsstring[]nullable
  • totalItemCountinteger · int32

    The total number of items for this query.

  • pageSizeinteger · int32

    The number of items to return for each page. This will only return a maximum of 100 items.

  • pageNumberinteger · int32

    The current page number.

  • pageCountinteger · int32

    The total number of pages available.