Skip to content
vocapable.Docs

The records behind one Today metric

GET
/v1/workspace/today/metrics/{metric}
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/today/metrics/open_opportunities \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
metric
required
Metric
string
Allowed values: open_opportunities open_value next_steps

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Read Today Metric V1 Workspace Today Metrics Metric Get
Array<object>
WorkspaceReportRecord
object
record_type
required
Record Type
string
id
required
Id
string
title
required
Title
string
detail
required
Detail
string
occurred_at
required
Any of:
string format: date-time
amount
required
Any of:
WorkspaceAmount
object
amount_minor
required
Amount Minor
integer
currency
required
Currency
string
link
required
Any of:
string
Examplegenerated
[
  {
    "record_type": "example",
    "id": "example",
    "title": "example",
    "detail": "example",
    "occurred_at": "2026-04-15T12:00:00Z",
    "amount": {
      "amount_minor": 1,
      "currency": "example"
    },
    "link": "example"
  }
]

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