List harvesters

get/v1/harvesters

This endpoint is in the contract, but the API doesn't serve it during early access. It returns 404 for now.

Harvesters owned by the org. assigned=false lists those free to pair (the screen form's picker).

curl "https://api.vojo-media.com/v1/harvesters" \
  -H "Authorization: Bearer $VOJO_KEY"

// Lists are capped at 100 a page. listAll follows the cursor for you.
for await (const item of listAll((cursor) =>
  api.GET("/v1/harvesters", { params: { query: { cursor, limit: 100 } } }),
)) {
  console.log(item);
}

Response 200

{
  "data": [
    {
      "id": "cm1hrv7c3b0001q9z5l2n8x4tg",
      "mac_address": "D8:3A:DD:41:7C:02",
      "version": "2.4.1",
      "description": null,
      "is_active": true,
      "enabled": true,
      "calibration_status": "calibrated",
      "last_calibration_at": "2026-09-30T07:00:00Z",
      "last_check_in_at": "2026-10-07T09:30:00Z",
      "sensor_style": "square",
      "screen_id": "cm1scr2w6n0001h8d4k9t3m7ve",
      "created_at": "2025-04-11T12:40:00Z",
      "updated_at": "2026-10-07T09:30:00Z"
    }
  ],
  "meta": {
    "next_cursor": "eyJpZCI6ImNtMXNjcjJ3Nm4wMDAxIn0",
    "has_more": true
  }
}

Access

Authentication: Secret key or OAuth access token.
Scope: harvesters:read
User permission: harvesterAccessPage

Query parameters

assignedboolean
True = paired to a screen; false = unassigned.
qstring
Search by MAC address or description.
1 to 100 characters
cursorstring
Opaque cursor from a previous response's meta.next_cursor. Omit for the first page.
limitinteger
Page size, 1-100. Default 25. A value outside 1-100, or not an integer, is rejected with 400 invalid_request (it is not clamped).
1 to 100
Default 25

Headers

Vojo-Organisationstring
The organisation this request acts on (org id). Required for oauth2 callers — a missing header returns 400 organisation_header_required; an org the user cannot access (a membership or an access grant, and granted to this OAuth client) returns 403 organisation_access_denied. Secret keys are bound to one org: the header may be omitted, and if sent it must match the key's org (else 403). Every query is scoped by the resolved org, never by an id in the body.
Vojo-Versionstring
Optional API version pin (a date). Overrides the version pinned on the secret key / organisation for this request. Echoed in the Vojo-Version response header. Within /v1 only additive changes ship, so most callers can omit it.
date

Response 200

dataarray of objectsRequired
Show 13 fields
- idstringRequired
  Harvester id. Opaque string — treat as an identifier, never parse it.
- mac_addressstringRequired
- versionstring or nullRequired
  Firmware version.
- descriptionstring or nullRequired
- is_activebooleanRequired
- enabledbooleanRequired
- calibration_statusstring or nullRequired
  Harvester calibration state.
  One of new, calibrated, new_screen, calibrating
- last_calibration_atstring or nullRequired
  RFC 3339 / ISO-8601 UTC timestamp, or null.
  date-time
- last_check_in_atstring or nullRequired
  Device-reported last check-in. Not monotonic (buffered flushes can move it back).
  date-time
- sensor_stylestring or nullRequired
  Fingerprint sensor patch style.
  One of square, quadrant_with_wings
- screen_idstring or nullRequired
  Screen it is paired to, or null when unassigned.
- created_atstringRequired
  RFC 3339 / ISO-8601 UTC timestamp.
  date-time
- updated_atstring or nullRequired
  RFC 3339 / ISO-8601 UTC timestamp, or null.
  date-time
metaobjectRequired
Pagination metadata for cursor-paginated lists.
Show 2 fields
- next_cursorstring or nullRequired
  Opaque cursor for the next page. Pass it back as cursor. null when there are no more results.
- has_morebooleanRequired
  True when another page exists (equivalent to next_cursor != null).

Response headers

Vojo-Versionstring
The API version (date) this response was rendered with — the request's Vojo-Version, else the key/org pin.
RateLimitstring
IETF RateLimit header: remaining quota in the current window, e.g. "default";r=97;t=42.
RateLimit-Policystring
IETF RateLimit-Policy header, e.g. "default";q=100;w=60. Portal OAuth clients get a higher tier.

Errors

Every error is application/problem+json. Branch on its code.

400
Malformed request: invalid JSON, a bad cursor, a missing Vojo-Organisation for an OAuth caller, or an unknown Vojo-Version.
401
Missing, invalid, expired or revoked credential.
403
The caller is authenticated but not allowed: missing scope (insufficient_scope), missing Permissions flag (permission_denied), a client/installer persona on an operator endpoint (operator_access_required), or no access to the requested org (organisation_access_denied).
422
Well-formed request that failed validation. errors[] lists each failing field.
429
Rate limit exceeded for this principal. Back off for Retry-After seconds.
500
Unexpected server failure.