latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

CredentialingWorkflow

Discover valid status transitions for a workflow

Returns the timeline event status options available to the current user for the credentialing workflow identified by workflowId. Results are filtered by the caller's permissions — only transitions the caller is authorized to create are returned. Call this endpoint before POST /credentialing-workflows/{workflowId}/timeline-events to determine which name values are valid and which additional parameters each transition requires. Returns a StatusOptionsResponse object.

get/credentialing-workflows/{workflowId}/timeline-events/status-options

Path parameters

workflowIdstring required

ID of the credentialing workflow

Headers

tenant-idstring required

Tenant ID

Response

Successfully retrieved timeline event status options

Example response

{
  "statusOptions": [
    {
      "name": "CRED_APPROVED",
      "required": [
        "name",
        "credentialingDecisionDate"
      ],
      "optional": [
        "nextCredentialingDate"
      ]
    }
  ]
}