Docs / Using the API

Response format

Every list endpoint wraps its results in a consistent JSON envelope with pagination metadata.

  1. Envelope fields
  2. Example response
  3. Pagination
  4. The finances envelope

List endpoints return their results inside a consistent envelope. This keeps pagination, timing and result counts predictable across every resource.

Envelope fields

Field Type Description
data array The list of resource objects for the current page.
links object Cursor links: first, last, prev, next (any may be null).
meta object Pagination metadata (see below).
results integer Number of objects returned in data for this page.
served_in string Server-side processing time, e.g. "12.34ms".

The meta object contains: current_page, from, last_page, per_page, to, total, and path.

Example response

{
  "data": [
    { "id": 1, "name": "Apollo", "slug": "apollo", "client_id": 4, "created_at": "2026-01-15T09:30:00+00:00" }
  ],
  "links": {
    "first": "https://rocketeersapp.com/api/your-team/projects?page=1",
    "last": "https://rocketeersapp.com/api/your-team/projects?page=5",
    "prev": null,
    "next": "https://rocketeersapp.com/api/your-team/projects?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 20,
    "to": 20,
    "total": 92,
    "path": "https://rocketeersapp.com/api/your-team/projects"
  },
  "results": 20,
  "served_in": "12.34ms"
}

Pagination

Parameter Type Default Maximum Description
per_page integer 20 50 Number of objects per page.
page integer 1 N/A The page to retrieve.

Request a specific page and page size by combining both parameters:

curl "https://rocketeersapp.com/api/your-team/projects?per_page=50&page=2" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

Values above the maximum are rejected with a 422 validation error.

The finances envelope

The Finances endpoint is not paginated and returns a different shape, data, totals and grand_total instead of links and meta:

{
  "data": [
    { "label": "Servers", "amount": 240.00, "currency": "EUR" }
  ],
  "totals": {
    "EUR": 240.00
  },
  "grand_total": 240.00,
  "results": 1,
  "meta": [],
  "served_in": "8.10ms"
}