Developers
Users

List user notes

GET/users/{user_id}/notes

Returns the internal notes recorded about the user.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

user_id*string

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/users/string/notes"
{  "data": [    {      "author": {        "kind": "admin"      },      "body": "string",      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "object": "user_note",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

Delete a custom field value DELETE

Clears the user's value for a custom field. The custom field itself is not affected. The operation is idempotent: clearing a value that is not set also succeeds.

Create a user note POST

Adds an internal note about the user. The note is attributed to the credential that created it, and only that credential can later edit or delete it.