Docs / Using the API

Finances

A finance overview for a team, line items, per currency totals, and a grand total.

  1. Endpoint
  2. Query parameters
  3. Example request
  4. Example response

Returns a finance overview for a team: a list of cost line items, per currency totals, and a single grand total. This endpoint is not paginated.

Endpoint

GET /api/{team}/finances

Required ability: finances:read

Query parameters

This endpoint takes no query parameters.

Example request

curl "https://rocketeersapp.com/api/your-team/finances" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

Example response

The exact line item structure is computed server side from your team's resources, so treat the items below as illustrative rather than a fixed schema.

{
  "data": [
    { "label": "Servers", "amount": 240.00, "currency": "EUR" },
    { "label": "Storages", "amount": 35.50, "currency": "EUR" },
    { "label": "Databases", "amount": 80.00, "currency": "EUR" }
  ],
  "totals": {
    "EUR": 355.50
  },
  "grand_total": 355.50,
  "results": 3,
  "meta": [],
  "served_in": "8.10ms"
}

See Response format for how this envelope differs from the paginated list endpoints.