List the platform template library

GET

/v1/templates

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

Authorizations

• HTTPBearer

Parameters

Query Parameters

limit

Limit

integer

default: 50 >= 1 <= 200

cursor

Any of:

string

string

null

null

outcome_type

Any of:

string

string

null

null

Filter on outcome_type. Comma-separated values are OR.

outcome_type.gte

Any of:

string

string

null

null

Filter on outcome_type with the gte operator.

outcome_type.lte

Any of:

string

string

null

null

Filter on outcome_type with the lte operator.

outcome_type.gt

Any of:

string

string

null

null

Filter on outcome_type with the gt operator.

outcome_type.lt

Any of:

string

string

null

null

Filter on outcome_type with the lt operator.

outcome_type.in

Any of:

string

string

null

null

Filter on outcome_type with the in operator.

use_case

Any of:

string

string

null

null

Filter on use_case. Comma-separated values are OR.

use_case.gte

Any of:

string

string

null

null

Filter on use_case with the gte operator.

use_case.lte

Any of:

string

string

null

null

Filter on use_case with the lte operator.

use_case.gt

Any of:

string

string

null

null

Filter on use_case with the gt operator.

use_case.lt

Any of:

string

string

null

null

Filter on use_case with the lt operator.

use_case.in

Any of:

string

string

null

null

Filter on use_case with the in operator.

Responses

200

Successful Response

Media typeapplication/json

CursorPage[TemplateSummary]

object

data

required

Data

Array<object>

TemplateSummary

A platform-owned, versioned seed (CANON fact 72). Templates carry no tenant.

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

next_cursor

Any of:

string

string

null

null

has_more

Has More

boolean

Example

{
  "data": [
    {
      "use_case": "sdr",
      "outcome_type": "appointment",
      "tool_grants": [
        "check_calendar"
      ],
      "status": "draft"
    }
  ],
  "has_more": false
}

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

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}