Skip to content

REST API

The REST API lives under https://api.linyup.com/v1/ and authenticates with an API key from Settings → API keys. It is read-only.

Send the key as a bearer token:

Terminal window
curl -H "Authorization: Bearer lyp_live_…" "https://api.linyup.com/v1/contacts?limit=5"

GET /v1/me tells you which studio the key belongs to and which of its scopes it can use right now.

The full, always-current reference is the OpenAPI 3 document at GET /v1/openapi.json. It needs no authentication and holds no studio data. Import it into Postman, Insomnia or your code generator of choice.

Endpoint Returns Scope
GET /v1/me The key and studio you are authenticated as none
GET /v1/team The studio none
GET /v1/contacts Contacts (personal details only with contacts:read:pii) contacts:read
GET /v1/contacts/{id} One contact contacts:read
GET /v1/contacts/{id}/history A contact’s bookings and check-ins contacts:read + schedule:read
GET /v1/sessions Scheduled sessions schedule:read
GET /v1/sessions/{id} One session schedule:read
GET /v1/sessions/{id}/roster Who is booked into a session schedule:read
GET /v1/activities Your activities offerings:read
GET /v1/plans Your plans offerings:read
GET /v1/subscriptions?state= Subscriptions, filtered by state subscriptions:read
GET /v1/events Events schedule:read
GET /v1/reports/weekly Weekly reports (?weeks=, up to 26) reports:read
GET /v1/reports/finance Finance reports (?from=&to= as YYYY-MM) finance:read
GET /v1/insights/class-fill Class fill rates schedule:read

Date windows (from, to) take a date such as 2026-10-12, read in your studio’s timezone, or a full date and time with an offset.

Lists answer with { "data": [ … ], "next_cursor": "…" }. Pass limit (default 50 and at most 200 on most lists; the OpenAPI document has each one) and, for the next page, cursor=<next_cursor> with the same filters. next_cursor is null on the last page. A cursor used with different filters is refused.

Errors come as { "error": { "code": "…", "message": "…", "hint": "…" } }; hint is there when there is something to try.

Status Code Meaning
400 invalid_request A parameter is missing or wrong
400 invalid_cursor The cursor is not one this API issued, or the filters changed
401 unauthenticated The key is missing, unknown, expired or revoked
403 insufficient_scope The key lacks the scope, or its creator can no longer use it
404 not_found No such record in this studio
409 feature_unavailable The add-on this needs is not active
422 window_too_wide The date window is too long
429 rate_limited Too many requests; wait for the Retry-After seconds
500 internal Something went wrong on our side

Each key may send short bursts of up to 60 requests and 120 requests a minute over time. Past that, the API answers 429 with a Retry-After header.

To show your offers, plans and schedule on your own website, use the website data feed instead: it needs no API key and shares only public data.