Skip to content
vocapable.Docs

Scorecards with their current version

GET
/v1/workspace/quality/scorecards
curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/quality/scorecards?include_archived=false' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
include_archived
Include Archived
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
QualityScorecards
object
data
required
Data
Array<object>
QualityScorecard
object
id
required
Id
string
name
required
Name
string
description
required
Any of:
string
status
required
Status
string
Allowed values: active archived
assignment
required
QualityAssignment

Which calls and text conversations a scorecard applies to; an empty list means any, and the dimensions are AND-ed. handler_kinds includes ai to grade the AI agents’ calls with the same card (PRD D2). When several cards match one piece of work, a card naming its queue comes first, then one naming its handler’s team, then the rest (docs/contact-center/quality.md § Assignment).

object
directions
Directions
Array<string>
Allowed values: inbound outbound
handler_kinds
Handler Kinds
Array<string>
>= 1 items
Allowed values: human ai
queue_keys
Queue Keys
Array<string>
<= 200 items
team_ids
Team Ids
Array<string>
<= 50 items
channel
Channel
string
default: voice
Allowed values: voice sms any
current_version
required
QualityScorecardVersion
object
id
required
Id
string
version
required
Version
integer
question_count
required
Question Count
integer
locked
required
Locked
boolean
sections
required
Sections
Array<object>
QualitySection
object
key
required
Key
string
title
required
Title
string
weight
required
Weight
integer
questions
required
Questions
Array<object>
QualityQuestion
object
key
required
Key
string
text
required
Text
string
type
required
Type
string
Allowed values: yes_no scale
weight
required
Weight
integer
allow_na
required
Allow Na
boolean
auto_fail
required
Auto Fail
boolean
guidance
required
Any of:
string
fingerprint
required
Fingerprint
string
points
required
Points
number
created_at
required
Created At
string format: date-time
versions
required
Versions
Array<object>
QualityScorecardVersionSummary
object
id
required
Id
string
version
required
Version
integer
question_count
required
Question Count
integer
locked
required
Locked
boolean
created_at
required
Created At
string format: date-time
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
  "data": [
    {
      "status": "active",
      "assignment": {
        "directions": [
          "inbound"
        ],
        "handler_kinds": [
          "human"
        ],
        "channel": "voice"
      },
      "current_version": {
        "sections": [
          {
            "questions": [
              {
                "type": "yes_no"
              }
            ]
          }
        ]
      }
    }
  ]
}

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