API Reference›Servicing Plane›Workforce›List servicing users

List servicing users

GEThttps://sandbox.api.lendeasy.ai/v1/servicing/usersImplementedBearer token ·READ_SERVICING_USER

Lists composed human login and servicing-worker profiles using declared filters and offset pagination.

Request

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

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

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

{
  "items": [
    {
      "userId": 4101,
      "username": "maria.agent",
      "displayName": "Maria Agent",
      "email": "maria@example.invalid",
      "officeId": 1,
      "roleIds": [
        7
      ],
      "active": true,
      "credentialResetRequired": true,
      "workerProfile": {
        "queueCodes": [
          "COLLECTIONS"
        ],
        "taskTypeCodes": [
          "COLLECTIONS_OUTREACH"
        ],
        "skills": [
          "COLLECTIONS"
        ],
        "languages": [
          "en"
        ],
        "capacity": 8
      },
      "lastModifiedAt": "2026-07-25T18: 30:00Z"
    }
  ],
  "limit": 50,
  "offset": 0,
  "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.
active optional in query	boolean	Filter by active state.
officeId optional in query	integer	Filter by public office ID.
roleId optional in query	integer	Filter by assigned role ID.
queueCode optional in query	string	Filter by servicing queue membership.
limit optional in query	integer	Maximum rows to return; defaults to 50.
offset optional in query	integer	Zero-based row offset; defaults to 0.
sort optional in query	string	Allowlisted sort field for this collection.
order optional in query	string	Sort direction. One of `asc · desc`.

Request

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

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

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

{
  "items": [
    {
      "userId": 4101,
      "username": "maria.agent",
      "displayName": "Maria Agent",
      "email": "maria@example.invalid",
      "officeId": 1,
      "roleIds": [
        7
      ],
      "active": true,
      "credentialResetRequired": true,
      "workerProfile": {
        "queueCodes": [
          "COLLECTIONS"
        ],
        "taskTypeCodes": [
          "COLLECTIONS_OUTREACH"
        ],
        "skills": [
          "COLLECTIONS"
        ],
        "languages": [
          "en"
        ],
        "capacity": 8
      },
      "lastModifiedAt": "2026-07-25T18: 30:00Z"
    }
  ],
  "limit": 50,
  "offset": 0,
  "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": []
}