Skip to Content
HelvetlyDocs
API referenceEngagements

List the entries of an engagement

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/{id}/entries

The delivery log: work done, newest first, each with the invoice that covers it, if any.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

id*string

The engagement's id.

Query Parameters

period_id?string

Only this period's entries.

Response Body

OK

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://app.helvetly.com/api/v1/engagements/string/entries'
Example Response
{  "data": [    {      "id": "string",      "period_id": "string",      "date": "2019-08-24",      "quantity": "string",      "note": "string",      "performed_by": {        "id": "string",        "name": "string"      },      "invoice": {        "id": "string",        "number": "string",        "status": "string",        "kind": "string"      },      "created_at": "2019-08-24T14:15:22Z",      "created_by": {        "id": "string",        "name": "string"      }    }  ]}