v1

latestOpenAPI 3.0.02026-07-148061.0 KB
Note

Get notes by order ID

Retrieves notes related to a specific order ID.

Permissions

This endpoint does not require License Manager resources.

get/notes

Query parameters

target.idstring required
Example:1172452900788-01

Order ID.

perPageinteger
Example:20

Number of notes per page. Maximum: 30.

pageinteger
Example:3

Number of the page to be retrieved.

reasonstring
Example:data-validation

This parameter is relevant only for accounts using Data Protection Plus. When sending requests to this endpoint, accounts with the PII data architecture can use this parameter to declare the reason for requesting unmasked data. Otherwise, this endpoint will return masked PII data.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

{"stackTrail":"paths:/notes:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}
All 8 operations