API Requests & Responses

The response envelope, paging, the money and date conventions, and how writes work on the Seayora REST API.

Response envelope

Collections answer with data plus pagination; a single record answers with data alone. Every response carries a request_id, echoed in the X-Request-Id header — quote it if you ever need support to trace a call.

GET https://seayora.com/api/v1/properties?limit=2&offset=0

{
  "data": [ { "id": 42, "name": "…", "rent": 2400, "occupancy": "vacant" } ],
  "pagination": {
    "limit": 2, "offset": 0, "count": 2,
    "has_more": true, "next_offset": 2
  },
  "request_id": "req_8f1c2b…"
}

Paging

limit (max 200, default 50) and offset. Keep requesting while has_more is true, using next_offset — no cursor bookkeeping.

Types

  • Money is a JSON number in US dollars, rounded to cents — never a string and never cents-as-integer.
  • Dates and timestamps are ISO-8601.
  • A field that has no value is null, never omitted, so you can rely on the shape.

Writing

POST creates and answers 201. PATCH updates and takes only the fields you are changing. There is no PUT — nothing here is replace-the-whole-object.

PATCH https://seayora.com/api/v1/work-orders/318
Content-Type: application/json

{ "status": "completed" }

Generating a client

Point any OpenAPI generator at https://seayora.com/api/v1/openapi.json for a typed client. It is generated from the live route table, so a new endpoint appears there the moment it exists.

npx @openapitools/openapi-generator-cli generate \
  -i https://seayora.com/api/v1/openapi.json \
  -g typescript-fetch -o ./seayora-client

Every endpoint

GET https://seayora.com/api/v1 needs no credential and returns the full endpoint table plus the conventions above — it is the fastest way to see what exists right now, with the permission each one needs.

Related guides

Related features and guides

  • API Authentication & API Keys — Documentation. The three credentials Seayora accepts, live versus test keys, what a credential can see, and how to keep keys safe.
  • API Rate Limits & Error Codes — Documentation. The error shape, every stable error code and what to do about it, rate-limit headers, and how to retry well.
  • Webhooks — Documentation. Get pushed an event when something changes instead of polling: the payload, signature verification, delivery guarantees and the event list.
  • Streamline Property Maintenance with Smart Dispatch — Guide. How a structured maintenance workflow — requests, routing, approval limits, and a trusted contractor network — cuts response times and keeps tenants happy.
  • Maintenance Requests & Work Orders — Feature. Tenants submit work orders with photos and video from their phone. Landlords triage, dispatch, and track every request to completion in one place.

Explore Seayora