Summarise engagements needing attention (GET /api/v1/engagements/summary)

Needs a token with the read:engagements scope (or write:engagements). Authentication

Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.

GET

/api/v1/engagements/summary

GET

/api/v1/engagements/summary

Counts of active engagements and of those ending soon, under pace, in overage or with something to invoice.

Authorization

bearerAuth

headerAuthorizationBearer <token>

A personal API token, hvt_…, with scopes such as read:* or write:invoices

Query Parameters

client_id?string

Only this client's.

Response Body

application/json

response

data*

Counts of engagements needing attention.

Example Request

curl -X GET 'https://app.helvetly.com/api/v1/engagements/summary'

Example Request

curl -X GET 'https://app.helvetly.com/api/v1/engagements/summary'

Example ResponseSchema

{
  "data": {
    "active": 0,
    "ending_soon": 0,
    "under_pace": 0,
    "overage": 0,
    "to_invoice": 0
  }
}

{  "data": {    "active": 0,    "ending_soon": 0,    "under_pace": 0,    "overage": 0,    "to_invoice": 0  }}

Summarise engagements needing attention

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Query Parameters

Response Body