Skip to content
Vocapable Developers

Read one template, seed included

GET
/v1/templates/{template_id}
curl --request GET \
  --url https://api.vocapable.com/v1/templates/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
template_id
required
Template Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
TemplateResource

Adds the full seed - objectives and their scoring blocks.

object
id
required
Id
string
name
required
Name
string
use_case
required
Use Case
string
Allowed values: sdr staffing survey reminder custom receptionist recruiting
version
required
Version
integer
outcome_type
required
Outcome Type
string
Allowed values: appointment shift_confirmation survey_response none
tool_grants
required
Tool Grants
Array<string>
Allowed values: check_calendar book_meeting send_sms send_verification_code verify_identity record_sms_consent take_message open_ticket update_lead record_survey_answer confirm_shift record_shift_response record_qualification schedule_callback transfer_to_human record_optout end_call custom_webhook
webhook_payload_schema
required
Webhook Payload Schema
object
key
additional properties
any
content_hash
required
Content Hash
string
status
required
Status
string
Allowed values: draft published deprecated
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
objectives
required
Objectives
Array<object>
object
key
additional properties
any
Example
{
  "use_case": "sdr",
  "outcome_type": "appointment",
  "tool_grants": [
    "check_calendar"
  ],
  "status": "draft"
}

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