Getting started with the API

LyncView has a public REST API for reading project data and pushing updates programmatically. API access is included with the Business plan. See the full reference at /api-docs.

Step 1: generate an API key

1. Go to Settings → API Keys.
2. Click New Key, give it a label (e.g., "Zapier integration").
3. Copy the key. It's shown once — store it securely.

Step 2: make a request

Authentication uses a Bearer token in the Authorization header:

curl https://lyncview.com/api/public/projects \
  -H "Authorization: Bearer YOUR_API_KEY"

Step 3: handle the response

JSON response with active projects scoped to your workspace:

[
  {
    "id": "abc-123",
    "name": "456 Oak Ave — Kitchen Renovation",
    "address": "456 Oak Ave",
    "town": "Springfield",
    "client_name": "Sarah Miller",
    "status": "active",
    "created_at": "2026-04-15T14:32:00Z",
    "updated_at": "2026-04-28T09:15:00Z"
  },
  ...
]

Rate limits

The API is rate-limited to 60 requests per minute per API key. If you exceed this, you'll get a 429 response with a Retry-After header indicating when to retry.

Error handling

• 401 Unauthorized: Missing or invalid API key
• 403 Forbidden: API key valid but plan doesn't include API access
• 404 Not Found: Resource doesn't exist or you don't have access
• 429 Too Many Requests: Rate limit exceeded
• 500 Internal Server Error: Something broke on our end. Retry with exponential backoff.

Security best practices

• Never commit API keys to version control
• Use environment variables in your code
• Generate a separate key per integration (so you can revoke selectively)
• Rotate keys periodically — old keys can be revoked from the API Keys page

For the full endpoint reference and webhook documentation, see /api-docs.