Skip to content
vocapable.Docs

One workflow starter, its plan versions and runs

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
recipe_id
required
Recipe Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceWorkflowRecipe
object
id
required
Id
string
Allowed values: missed_call meeting sale_service lead_review
slug
required
Slug
string
name
required
Name
string
tag
required
Tag
string
description
required
Description
string
tools
required
Tools
Array<object>
WorkspaceWorkflowTool
object
provider
required
Provider
string
name
required
Name
string
status
required
Status
string
steps
required
Steps
Array<string>
stops
required
Stops
Array<string>
result
required
Result
string
latest_plan
required
Any of:
WorkspaceWorkflowPlan
object
id
required
Id
string
recipe
required
Recipe
string
Allowed values: missed_call meeting sale_service lead_review
version
required
Version
integer
status
required
Status
string
Allowed values: draft reviewed active paused retired
owner
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
remind_after
required
Any of:
string
Allowed values: 15m 1h next_business_day
digest
required
Any of:
string
reviewed_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
reviewed_at
required
Any of:
string format: date-time
activated_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
activated_at
required
Any of:
string format: date-time
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
active_plan
required
Any of:
WorkspaceWorkflowPlan
object
id
required
Id
string
recipe
required
Recipe
string
Allowed values: missed_call meeting sale_service lead_review
version
required
Version
integer
status
required
Status
string
Allowed values: draft reviewed active paused retired
owner
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
remind_after
required
Any of:
string
Allowed values: 15m 1h next_business_day
digest
required
Any of:
string
reviewed_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
reviewed_at
required
Any of:
string format: date-time
activated_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
activated_at
required
Any of:
string format: date-time
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
runs
required
WorkspaceWorkflowRunCounts
object
waiting
required
Waiting
integer
held
required
Held
integer
completed
required
Completed
integer
cancelled
required
Cancelled
integer
Example
{
  "id": "missed_call",
  "latest_plan": {
    "recipe": "missed_call",
    "status": "draft",
    "remind_after": "15m"
  },
  "active_plan": {
    "recipe": "missed_call",
    "status": "draft",
    "remind_after": "15m"
  }
}

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