Opportunities you can see

GET

/v1/workspace/opportunities

curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/opportunities?view=mine&open=false&limit=50' \
  --header 'Authorization: Bearer <token>'

Newest first. A rep sees only the deals they own, whatever view says; q matches the deal title or the customer’s name.

Authorizations

• HTTPBearer

Parameters

Query Parameters

view

View

string

default: all

Allowed values: mine all

stage

Any of:

string

string

Allowed values: new qualified proposal won lost deferred

null

null

organization_id

Any of:

string

string

null

null

open

Open

boolean

status

Any of:

string

string

Allowed values: open closed

null

null

q

Any of:

string

string

<= 200 characters

null

null

limit

Limit

integer

default: 50 >= 1 <= 200

cursor

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

CursorPage[WorkspaceOpportunity]

object

data

required

Data

Array<object>

WorkspaceOpportunity

object

id

required

Id

string

organization_id

required

Organization Id

string

organization_name

required

Organization Name

string

primary_contact_id

required

Any of:

string

string

null

null

owner

required

Any of:

WorkspacePersonRef

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

null

null

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

string

null

null

next_step

required

Any of:

string

string

null

null

next_step_due_at

required

Any of:

string

string format: date-time

null

null

lost_reason

required

Any of:

string

string

null

null

deferred_until

required

Any of:

string

string format: date-time

null

null

closed_at

required

Any of:

string

string format: date-time

null

null

source

required

Any of:

string

string

null

null

accepted_scope

required

Any of:

string

string

null

null

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

string

null

null

amends_id

Any of:

string

string

null

null

scope_accepted_at

Any of:

string

string format: date-time

null

null

scope_accepted_by

Any of:

WorkspacePersonRef

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

null

null

scope_acceptance_id

Any of:

string

string

null

null

next_cursor

Any of:

string

string

null

null

has_more

Has More

boolean

Example

{
  "data": [
    {
      "stage": "new"
    }
  ],
  "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": {}
    }
  ]
}