Sign in

v1

latestOpenAPI 3.0.02026-07-148061.0 KB
Note

Retrieve note

Retrieves a given note in VTEX DO, filtering by note ID.

Permissions

This endpoint does not require License Manager resources.

get/notes/{noteId}

Path parameters

noteIdstring required
Example:654321cba

Note ID.

Query parameters

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/{noteId}:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}