API Reference›LMS API›Notes›Retrieve a note

Retrieve a note

GEThttps://sandbox.api.lendeasy.ai/v1/notes/{noteId} Bearer token · READ_LMS_NOTE

Returns the note with its current revision body. Sensitive bodies require the sensitive read permission; a redacted note returns a redaction placeholder and its prior content is never served again.

Request

curl https://sandbox.api.lendeasy.ai/v1/notes/$NOTE_ID \
  -H "Authorization: Bearer $TOKEN"

await fetch(`https://sandbox.api.lendeasy.ai/v1/notes/${noteId}`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/notes/{note_id}",
  headers={"Authorization": f"Bearer {token}"},
)

{
  "noteId": 802,
  "noteRef": "note_9c1d3e5f7a9b1c3d5e7f",
  "status": "ACTIVE",
  "sensitive": false,
  "pinned": false,
  "flagged": false,
  "redactionState": "NONE",
  "body": "Maya requested email delivery for the payoff figure."
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

Path & query parameters

Field	Type	Description
LendEasy-Tenant required in header	string	Tenant selector: lowercase letters, digits, and hyphens, 1-64 characters. Exactly one instance; the only tenant selector honored.
noteId required in path	string	Stable opaque note identifier.

Request

curl https://sandbox.api.lendeasy.ai/v1/notes/$NOTE_ID \
  -H "Authorization: Bearer $TOKEN"

await fetch(`https://sandbox.api.lendeasy.ai/v1/notes/${noteId}`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/notes/{note_id}",
  headers={"Authorization": f"Bearer {token}"},
)

{
  "noteId": 802,
  "noteRef": "note_9c1d3e5f7a9b1c3d5e7f",
  "status": "ACTIVE",
  "sensitive": false,
  "pinned": false,
  "flagged": false,
  "redactionState": "NONE",
  "body": "Maya requested email delivery for the payoff figure."
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}