The Pipeline board: lanes, closed deals and forecast

GET

/v1/workspace/pipeline

const url = 'https://api.vocapable.com/v1/workspace/pipeline?view=company';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/pipeline?view=company' \
  --header 'Authorization: Bearer <token>'

Authorizations

HTTPBearer

Parameters

Query Parameters

view

View

string

default: company

Allowed values: company mine

Responses

200

Successful Response

application/json

WorkspacePipelineBoard

object

scope

required

Scope

string

Allowed values: company mine

summary

required

WorkspacePipelineSummary

object

open_pipeline

required

Open Pipeline

Array<object>

WorkspaceMoney

One currency’s total. Currencies are never added together.

object

currency

required

Currency

string

amount_minor

required

Amount Minor

integer

count

required

Count

integer

recorded_sales

required

Recorded Sales

Array<object>

WorkspaceMoney

One currency’s total. Currencies are never added together.

object

currency

required

Currency

string

amount_minor

required

Amount Minor

integer

count

required

Count

integer

collected_payments

required

Collected Payments

Array<object>

WorkspaceMoney

One currency’s total. Currencies are never added together.

object

currency

required

Currency

string

amount_minor

required

Amount Minor

integer

count

required

Count

integer

handoffs_active

required

Handoffs Active

integer

handoffs_awaiting_acceptance

required

Handoffs Awaiting Acceptance

integer

lost_count

required

Lost Count

integer

deferred_count

required

Deferred Count

integer

revisit_due_count

required

Revisit Due Count

integer

new

required

New

Array<object>

WorkspacePipelineDeal

A board card: the deal, who is on it, and what holds it.

object

opportunity

required

WorkspaceOpportunity

object

required

string

organization_id

required

Organization Id

string

organization_name

required

Organization Name

string

primary_contact_id

required

Any of:

string
null

string

owner

required

Any of:

WorkspacePersonRef
null

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

title

required

Title

string

stage

required

Stage

string

Allowed values: new qualified proposal won lost deferred

amount_minor

required

Amount Minor

integer

currency

required

Currency

string

need

required

Any of:

string
null

string

next_step

required

Any of:

string
null

string

next_step_due_at

required

Any of:

string
null

string format: date-time

lost_reason

required

Any of:

string
null

string

deferred_until

required

Any of:

string
null

string format: date-time

closed_at

required

Any of:

string
null

string format: date-time

source

required

Any of:

string
null

string

accepted_scope

required

Any of:

string
null

string

revision

required

Revision

integer

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

reopened_from_id

Any of:

string
null

string

amends_id

Any of:

string
null

string

scope_accepted_at

Any of:

string
null

string format: date-time

scope_accepted_by

Any of:

WorkspacePersonRef
null

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

scope_acceptance_id

Any of:

string
null

string

primary_contact_name

required

Any of:

string
null

string

contact_hold

required

Contact Hold

boolean

revisit_due

required

Revisit Due

boolean

handoff

required

Any of:

WorkspaceHandoffSummary
null

WorkspaceHandoffSummary

object

required

string

status

required

Status

string

Allowed values: preparing awaiting_acceptance accepted clarification_requested declined blocked scheduled in_progress completed reopened cancelled

recipient

required

Any of:

WorkspacePersonRef
null

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

responsible

required

Any of:

WorkspacePersonRef
null

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

respond_by

required

Any of:

string
null

string format: date-time

overdue

required

Overdue

boolean

qualified

required

Qualified

Array<object>

WorkspacePipelineDeal

A board card: the deal, who is on it, and what holds it.

object

opportunity

required

WorkspaceOpportunity

object

required

string

organization_id

required

Organization Id

string

organization_name

required

Organization Name

string

primary_contact_id

required

Any of:

string
null

string

owner

required

Any of:

WorkspacePersonRef
null

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

title

required

Title

string

stage

required

Stage

string

Allowed values: new qualified proposal won lost deferred

amount_minor

required

Amount Minor

integer

currency

required

Currency

string

need

required

Any of:

string
null

string

next_step

required

Any of:

string
null

string

next_step_due_at

required

Any of:

string
null

string format: date-time

lost_reason

required

Any of:

string
null

string

deferred_until

required

Any of:

string
null

string format: date-time

closed_at

required

Any of:

string
null

string format: date-time

source

required

Any of:

string
null

string

accepted_scope

required

Any of:

string
null

string

revision

required

Revision

integer

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

reopened_from_id

Any of:

string
null

string

amends_id

Any of:

string
null

string

scope_accepted_at

Any of:

string
null

string format: date-time

scope_accepted_by

Any of:

WorkspacePersonRef
null

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

scope_acceptance_id

Any of:

string
null

string

primary_contact_name

required

Any of:

string
null

string

contact_hold

required

Contact Hold

boolean

revisit_due

required

Revisit Due

boolean

handoff

required

Any of:

WorkspaceHandoffSummary
null

WorkspaceHandoffSummary

object

required

string

status

required

Status

string

Allowed values: preparing awaiting_acceptance accepted clarification_requested declined blocked scheduled in_progress completed reopened cancelled

recipient

required

Any of:

WorkspacePersonRef
null

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

responsible

required

Any of:

WorkspacePersonRef
null

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

respond_by

required

Any of:

string
null

string format: date-time

overdue

required

Overdue

boolean

proposal

required

Proposal

Array<object>

WorkspacePipelineDeal

A board card: the deal, who is on it, and what holds it.

object

opportunity

required

WorkspaceOpportunity

object

required

string

organization_id

required

Organization Id

string

organization_name

required

Organization Name

string

primary_contact_id

required

Any of:

string
null

string

owner

required

Any of:

WorkspacePersonRef
null

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

title

required

Title

string

stage

required

Stage

string

Allowed values: new qualified proposal won lost deferred

amount_minor

required

Amount Minor

integer

currency

required

Currency

string

need

required

Any of:

string
null

string

next_step

required

Any of:

string
null

string

next_step_due_at

required

Any of:

string
null

string format: date-time

lost_reason

required

Any of:

string
null

string

deferred_until

required

Any of:

string
null

string format: date-time

closed_at

required

Any of:

string
null

string format: date-time

source

required

Any of:

string
null

string

accepted_scope

required

Any of:

string
null

string

revision

required

Revision

integer

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

reopened_from_id

Any of:

string
null

string

amends_id

Any of:

string
null

string

scope_accepted_at

Any of:

string
null

string format: date-time

scope_accepted_by

Any of:

WorkspacePersonRef
null

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

scope_acceptance_id

Any of:

string
null

string

primary_contact_name

required

Any of:

string
null

string

contact_hold

required

Contact Hold

boolean

revisit_due

required

Revisit Due

boolean

handoff

required

Any of:

WorkspaceHandoffSummary
null

WorkspaceHandoffSummary

object

required

string

status

required

Status

string

Allowed values: preparing awaiting_acceptance accepted clarification_requested declined blocked scheduled in_progress completed reopened cancelled

recipient

required

Any of:

WorkspacePersonRef
null

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

responsible

required

Any of:

WorkspacePersonRef
null

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

respond_by

required

Any of:

string
null

string format: date-time

overdue

required

Overdue

boolean

won

required

Won

Array<object>

WorkspacePipelineDeal

A board card: the deal, who is on it, and what holds it.

object

opportunity

required

WorkspaceOpportunity

object

required

string

organization_id

required

Organization Id

string

organization_name

required

Organization Name

string

primary_contact_id

required

Any of:

string
null

string

owner

required

Any of:

WorkspacePersonRef
null

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

title

required

Title

string

stage

required

Stage

string

Allowed values: new qualified proposal won lost deferred

amount_minor

required

Amount Minor

integer

currency

required

Currency

string

need

required

Any of:

string
null

string

next_step

required

Any of:

string
null

string

next_step_due_at

required

Any of:

string
null

string format: date-time

lost_reason

required

Any of:

string
null

string

deferred_until

required

Any of:

string
null

string format: date-time

closed_at

required

Any of:

string
null

string format: date-time

source

required

Any of:

string
null

string

accepted_scope

required

Any of:

string
null

string

revision

required

Revision

integer

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

reopened_from_id

Any of:

string
null

string

amends_id

Any of:

string
null

string

scope_accepted_at

Any of:

string
null

string format: date-time

scope_accepted_by

Any of:

WorkspacePersonRef
null

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

scope_acceptance_id

Any of:

string
null

string

primary_contact_name

required

Any of:

string
null

string

contact_hold

required

Contact Hold

boolean

revisit_due

required

Revisit Due

boolean

handoff

required

Any of:

WorkspaceHandoffSummary
null

WorkspaceHandoffSummary

object

required

string

status

required

Status

string

Allowed values: preparing awaiting_acceptance accepted clarification_requested declined blocked scheduled in_progress completed reopened cancelled

recipient

required

Any of:

WorkspacePersonRef
null

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

responsible

required

Any of:

WorkspacePersonRef
null

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

respond_by

required

Any of:

string
null

string format: date-time

overdue

required

Overdue

boolean

lost

required

Lost

Array<object>

WorkspacePipelineDeal

A board card: the deal, who is on it, and what holds it.

object

opportunity

required

WorkspaceOpportunity

object

required

string

organization_id

required

Organization Id

string

organization_name

required

Organization Name

string

primary_contact_id

required

Any of:

string
null

string

owner

required

Any of:

WorkspacePersonRef
null

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

title

required

Title

string

stage

required

Stage

string

Allowed values: new qualified proposal won lost deferred

amount_minor

required

Amount Minor

integer

currency

required

Currency

string

need

required

Any of:

string
null

string

next_step

required

Any of:

string
null

string

next_step_due_at

required

Any of:

string
null

string format: date-time

lost_reason

required

Any of:

string
null

string

deferred_until

required

Any of:

string
null

string format: date-time

closed_at

required

Any of:

string
null

string format: date-time

source

required

Any of:

string
null

string

accepted_scope

required

Any of:

string
null

string

revision

required

Revision

integer

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

reopened_from_id

Any of:

string
null

string

amends_id

Any of:

string
null

string

scope_accepted_at

Any of:

string
null

string format: date-time

scope_accepted_by

Any of:

WorkspacePersonRef
null

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

scope_acceptance_id

Any of:

string
null

string

primary_contact_name

required

Any of:

string
null

string

contact_hold

required

Contact Hold

boolean

revisit_due

required

Revisit Due

boolean

handoff

required

Any of:

WorkspaceHandoffSummary
null

WorkspaceHandoffSummary

object

required

string

status

required

Status

string

Allowed values: preparing awaiting_acceptance accepted clarification_requested declined blocked scheduled in_progress completed reopened cancelled

recipient

required

Any of:

WorkspacePersonRef
null

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

responsible

required

Any of:

WorkspacePersonRef
null

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

respond_by

required

Any of:

string
null

string format: date-time

overdue

required

Overdue

boolean

deferred

required

Deferred

Array<object>

WorkspacePipelineDeal

A board card: the deal, who is on it, and what holds it.

object

opportunity

required

WorkspaceOpportunity

object

required

string

organization_id

required

Organization Id

string

organization_name

required

Organization Name

string

primary_contact_id

required

Any of:

string
null

string

owner

required

Any of:

WorkspacePersonRef
null

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

title

required

Title

string

stage

required

Stage

string

Allowed values: new qualified proposal won lost deferred

amount_minor

required

Amount Minor

integer

currency

required

Currency

string

need

required

Any of:

string
null

string

next_step

required

Any of:

string
null

string

next_step_due_at

required

Any of:

string
null

string format: date-time

lost_reason

required

Any of:

string
null

string

deferred_until

required

Any of:

string
null

string format: date-time

closed_at

required

Any of:

string
null

string format: date-time

source

required

Any of:

string
null

string

accepted_scope

required

Any of:

string
null

string

revision

required

Revision

integer

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

reopened_from_id

Any of:

string
null

string

amends_id

Any of:

string
null

string

scope_accepted_at

Any of:

string
null

string format: date-time

scope_accepted_by

Any of:

WorkspacePersonRef
null

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

scope_acceptance_id

Any of:

string
null

string

primary_contact_name

required

Any of:

string
null

string

contact_hold

required

Contact Hold

boolean

revisit_due

required

Revisit Due

boolean

handoff

required

Any of:

WorkspaceHandoffSummary
null

WorkspaceHandoffSummary

object

required

string

status

required

Status

string

Allowed values: preparing awaiting_acceptance accepted clarification_requested declined blocked scheduled in_progress completed reopened cancelled

recipient

required

Any of:

WorkspacePersonRef
null

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

responsible

required

Any of:

WorkspacePersonRef
null

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

respond_by

required

Any of:

string
null

string format: date-time

overdue

required

Overdue

boolean

truncated

required

Truncated

boolean

Example

{
  "scope": "company",
  "new": [
    {
      "opportunity": {
        "stage": "new"
      },
      "handoff": {
        "status": "preparing"
      }
    }
  ],
  "qualified": [
    {
      "opportunity": {
        "stage": "new"
      },
      "handoff": {
        "status": "preparing"
      }
    }
  ],
  "proposal": [
    {
      "opportunity": {
        "stage": "new"
      },
      "handoff": {
        "status": "preparing"
      }
    }
  ],
  "won": [
    {
      "opportunity": {
        "stage": "new"
      },
      "handoff": {
        "status": "preparing"
      }
    }
  ],
  "lost": [
    {
      "opportunity": {
        "stage": "new"
      },
      "handoff": {
        "status": "preparing"
      }
    }
  ],
  "deferred": [
    {
      "opportunity": {
        "stage": "new"
      },
      "handoff": {
        "status": "preparing"
      }
    }
  ]
}

422

Validation Error

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

The Pipeline board: lanes, closed deals and forecast

Authorizations

Parameters

Query Parameters

Responses

200

Example

422

Examplegenerated

Example^generated