API Reference›Servicing Plane›Case effects›List case effects

List case effects

GEThttps://sandbox.api.lendeasy.ai/v1/servicing/cases/{caseId}/effectsImplementedBearer token ·READ_SERVICING_CASE

Lists workflow-created typed effects and redacted execution state; callers cannot create effects directly.

Request

curl https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/effects \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT"

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/effects`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/effects",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant},
)

{
  "items": [
    {
      "effectRef": "effect-cancel-autopay-1001-1",
      "caseId": 1001,
      "effectType": "CANCEL_AUTOPAY",
      "triggerType": "LMS_EVENT",
      "status": "COMPLETED",
      "attemptCount": 1,
      "createdAt": "2026-07-25T18: 30:00Z",
      "completedAt": "2026-07-25T18: 30:02Z"
    }
  ],
  "nextCursor": null,
  "hasMore": false
}

{
  "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	Opaque active LendEasy tenant-registry identifier. Supply exactly one instance; no alternate tenant selector is accepted.
caseId required in path	integer	Positive numeric case identifier.
status optional in query	string	Repeat to include multiple effect states.
effectType optional in query	string	Repeat to include multiple effect types.
triggerType optional in query	string	Exact trigger type.
createdFrom optional in query	string	Inclusive timestamp lower bound.
createdTo optional in query	string	Exclusive timestamp upper bound.
limit optional in query	integer	Maximum rows to return.
cursor optional in query	string	Opaque newest-first pagination cursor.

Request

curl https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/effects \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT"

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/effects`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/effects",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant},
)

{
  "items": [
    {
      "effectRef": "effect-cancel-autopay-1001-1",
      "caseId": 1001,
      "effectType": "CANCEL_AUTOPAY",
      "triggerType": "LMS_EVENT",
      "status": "COMPLETED",
      "attemptCount": 1,
      "createdAt": "2026-07-25T18: 30:00Z",
      "completedAt": "2026-07-25T18: 30:02Z"
    }
  ],
  "nextCursor": null,
  "hasMore": false
}

{
  "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": []
}