v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Notes

Search notes

Search for one or more notes.

get/v1/Notes

Query parameters

search.note_idinteger[]

Query by note identifier.

search.customer_idinteger[]

Query by account identifier.

search.request_idinteger[]

Query by request identifier.

search.note_type_idinteger[]

Query by note type identifier.

search.created_date_startstring date-time

Format - date-time (as date-time in RFC3339). Query by created date.

search.created_date_endstring date-time

Format - date-time (as date-time in RFC3339). Query by created date.

search.order_idinteger[]

Query by order identifier.

search.page_sizeinteger

Format - int32. Defines how many items to return at a time.

search.pageinteger

Format - int32. Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.