API Reference›Servicing Plane›Workflow administration›Export workflow definitions

Export workflow definitions

GEThttps://sandbox.api.lendeasy.ai/v1/servicing/admin/workflow-definitions/exportImplementedBearer token ·READ_SERVICING_WORKFLOW_DEFINITION

Exports definitions as a versioned bundle suitable for re-import, optionally limited to one key and excluding RETIRED versions by default.

Request

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

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

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

{
  "bundleFormat": 1,
  "definitions": [
    {
      "workflowKey": "COLLECTIONS_DEFAULT",
      "caseTypeCode": "COLLECTIONS",
      "versionNumber": 2,
      "status": "ACTIVE",
      "definition": {
        "schemaVersion": 2,
        "workflowKey": "COLLECTIONS_DEFAULT",
        "version": 2,
        "caseType": "COLLECTIONS",
        "stages": [
          {
            "stageKey": "INTAKE",
            "displayName": "Understand the case",
            "next": [
              {
                "when": "DEFAULT",
                "stage": "CLOSE"
              }
            ]
          },
          {
            "stageKey": "CLOSE",
            "displayName": "Close the case",
            "terminal": true
          }
        ],
        "terminalOutcomes": []
      }
    }
  ]
}

{
  "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.
workflowKey optional in query	string	Limit the bundle to one workflow key.
includeRetired optional in query	boolean	Include RETIRED versions; defaults to false.

Request

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

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

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

{
  "bundleFormat": 1,
  "definitions": [
    {
      "workflowKey": "COLLECTIONS_DEFAULT",
      "caseTypeCode": "COLLECTIONS",
      "versionNumber": 2,
      "status": "ACTIVE",
      "definition": {
        "schemaVersion": 2,
        "workflowKey": "COLLECTIONS_DEFAULT",
        "version": 2,
        "caseType": "COLLECTIONS",
        "stages": [
          {
            "stageKey": "INTAKE",
            "displayName": "Understand the case",
            "next": [
              {
                "when": "DEFAULT",
                "stage": "CLOSE"
              }
            ]
          },
          {
            "stageKey": "CLOSE",
            "displayName": "Close the case",
            "terminal": true
          }
        ],
        "terminalOutcomes": []
      }
    }
  ]
}

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