Workflows

The GET /Workflows end point returns workflow records associated with evaluated conversations(e.g. reconsideration or appeal workflows that were initiated after an evaluation was submitted). Each record includes the workflow type, name, and current status, along with the evaluation number and interaction identifier needed to cross-reference with evaluation and transcript data.

Results can be filtered by date range using either the workflow creation date or the original interaction date.

📘

Note on Workflows: GET /Workflows/ returns an InteractionId field. This is a different identifier from the conversation ID used across other sections of this documentation, and cannot be passed directly to the Transcriptions or Insights endpoints.

To retrieve the transcript or classifier results for a workflow conversation, use the ClientCallId from the workflow record (which maps to your original source system identifier) as a filter in GET /Metadata/ or POST /Metadata/. This will return the matching conversation record, including its Id. You can then pass that Id to:

  • GET /Conversations/Transcriptions/{conversationId}/ to retrieve the transcript
  • GET /Conversations/Insights/ (filtered by date range) to retrieve classifier results
  • GET /Evaluations/ or GET /Evaluations/Modules/ (filtered by date range and status) to retrieve the full evaluation record

If the workflow record does not include a ClientCallId, use the interaction date alongside a date range filter in GET /Metadata/ to locate the conversation.