Skip to content
Vocapable Developers

List latest saved workforce and qualification responses

GET
/v1/workflow-outcomes
curl --request GET \
  --url 'https://api.vocapable.com/v1/workflow-outcomes?limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
fit_status
Any of:
string
Allowed values: good_fit not_a_fit needs_follow_up unreviewed superseded
workflow
Any of:
string
Allowed values: workforce sales recruiting
response
Any of:
string
<= 64 characters
agent_id
Any of:
string
<= 128 characters
campaign_id
Any of:
string
>= 1 characters <= 128 characters
start
Any of:
string format: date-time

Inclusive lower bound, ISO-8601. The attempt and turn ledgers are month-partitioned, so a report must name both sides of its window and may span at most 93 days.

end
Any of:
string format: date-time

Exclusive upper bound, ISO-8601.

limit
Limit
integer
default: 50 >= 1 <= 200
cursor
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CursorPage[WorkflowOutcome]
object
data
required
Data
Array<object>
WorkflowOutcome
object
id
required
Id
string
call_id
required
Call Id
string
contact_id
required
Any of:
string
kind
required
Kind
string
Allowed values: shift_response qualification identity_capture identity_correction
subject_ref
required
Subject Ref
string
revision
required
Revision
integer
>= 1
response
required
Response
string
payload
required
Payload
object
key
additional properties
any
source_turns
Source Turns
Array<object>
ConversationEvidence
object
turn_number
required
Turn Number
integer
>= 1
text
required
Text
string
>= 1 characters <= 6000 characters
action_confirmation
Any of:
ActionConfirmationProof

Runtime-created attestation, never a model-authored tool argument.

This attests the trusted runtime’s ledger, not independently verified audio. A fresh native tool call is still required before dispatch.

object
kind
required
Kind
string
Allowed values: shift_response qualification
subject_ref
required
Subject Ref
string
>= 1 characters <= 64 characters
response
required
Response
string
Allowed values: accepted declined tentative interested not_interested needs_follow_up unknown
policy_version
Policy Version
string
default: exact_action_v1
Allowed value: exact_action_v1
confirming_turn
required
ConversationEvidence
object
turn_number
required
Turn Number
integer
>= 1
text
required
Text
string
>= 1 characters <= 6000 characters
method
required
Method
string
Allowed values: explicit_statement heard_readback
readback
Any of:
HeardReadbackEvidence

Known playback completion followed by a trusted caller speech onset.

Queue/send times do not establish playback start or completion. Receive time is not caller onset. Unknown or cleared playback cannot produce this proof.

object
question_id
required
Question Id
string
>= 1 characters <= 128 characters
question_text
required
Question Text
string
>= 1 characters <= 6000 characters
playback_completed_at
required
Playback Completed At
string format: date-time
caller_started_at
required
Caller Started At
string format: date-time
created_at
required
Created At
string format: date-time
workflow
required
Workflow
string
Allowed values: workforce sales recruiting
agent_id
required
Agent Id
string
agent_name
required
Agent Name
string
contact_name
Any of:
string
use_case
required
Use Case
string
call_record_available
required
Call Record Available
boolean
qualification_coverage
Any of:
QualificationCoverage

Complete configured question inventory for one current receipt, not a page total.

object
status
required
Status
string
Allowed values: available invalid_record invalid_configuration workflow_mismatch
questions
Questions
Array<object>
<= 50 items
QualificationQuestionCoverage
object
question_id
required
Question Id
string
prompt
Any of:
string
answer_status
required
Answer Status
string
Allowed values: answered unknown refused not_recorded
answer
Any of:
string
fit_review
Any of:
QualificationReviewState

A review applies only to its source receipt, never to later corrections.

object
status
required
Status
string
Allowed values: unreviewed reviewed superseded unavailable
current_action_id
Any of:
string
latest_review
Any of:
QualificationReview
object
id
required
Id
string
action_id
required
Action Id
string
revision
required
Revision
integer
>= 1
decision
required
Decision
string
Allowed values: good_fit not_a_fit needs_follow_up
reason
required
Reason
string
reviewer_ref
required
Reviewer Ref
string
created_at
required
Created At
string format: date-time
next_cursor
Any of:
string
has_more
Has More
boolean
Example
{
  "data": [
    {
      "kind": "shift_response",
      "action_confirmation": {
        "kind": "shift_response",
        "response": "accepted",
        "policy_version": "exact_action_v1",
        "method": "explicit_statement"
      },
      "workflow": "workforce",
      "qualification_coverage": {
        "status": "available",
        "questions": [
          {
            "answer_status": "answered"
          }
        ]
      },
      "fit_review": {
        "status": "unreviewed",
        "latest_review": {
          "decision": "good_fit"
        }
      }
    }
  ],
  "has_more": false
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}