API v1Stable contract

Your form system,
programmable.

Create live forms, read qualified responses, and bring essential analytics into your own workflows through one lean JSON API.

Start with a scoped access token

Create it in your Qualyo dashboard, copy it once, and keep it on your server.

Create access tokenOpenAPI JSON

Bearer authentication

qly_live_••••••••

Predictable limits

120 reads · 30 writes / minute

Safe by default

Scopes · idempotency · revisions

GET/api/v1/me

Get API principal

Identify the account represented by the bearer token and inspect its effective scopes.

Bearer token requiredAny active API token

Every response includes X-Request-Id plus RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset headers. Authenticated responses are private and never cached.

Parameters

Path, query, and header values accepted by this operation.

This endpoint has no path, query, or operation-specific headers.

Request body

Unknown JSON fields are rejected instead of silently ignored.

No JSON request body.

Response

The authenticated API principal.

200 OK
Output JSONapplication/json
{
  "id": "0df86ab5-79a1-4e23-95b7-101e32a62769",
  "email": "owner@example.com",
  "plan": "pro_750",
  "scopes": [
    "workspaces:read",
    "forms:read",
    "forms:write",
    "submissions:read",
    "analytics:read"
  ]
}
id
Type

UUID

Requirement

Required

Description

Immutable Qualyo account identifier.

email
Type

string | null

Requirement

Required

Description

Account email, or null when unavailable.

plan
Type

enum

Requirement

Required

Description

Current product plan.

Options:

freepro_250pro_750pro_2000pro_5000legacy_pro
scopes
Type

string[]

Requirement

Required

Description

Permissions attached to this token.

Possible errors

Error JSONapplication/json
{
  "type": "https://qualyoforms.com/problems/invalid-api-key",
  "title": "Invalid Api Key",
  "status": 401,
  "detail": "The bearer token is missing, invalid, expired, revoked, or is an MCP token.",
  "code": "invalid-api-key",
  "request_id": "4b96a6ad-f749-45e5-9ae7-2261bca61739"
}
401invalid-api-key

The bearer token is missing, invalid, expired, revoked, or is an MCP token.

429rate-limited

The credential exceeded its current request allowance.

503service-unavailable

A required dependency is temporarily unavailable.