OpenAPI
The OpenAPI files are the source contract for request schemas, responses, errors and supported operations.
openapi: 3.0.3
info:
title: Quardlyn CRM API
version: v1
description: >
Public CRM API contract for third-party property CRM integrations.
Version v1 is STABLE (API Contract Frozen) as of 2026-07-03. Developers
can build against v1, new backward-compatible features may be added, and
no public API contract changes may be made to v1 unless they are backward
compatible or approved as a breaking v2 change.
servers:
- url: https://{host}/api/v1/crm
variables:
host:
default: example.quardlyn.test
security:
- CrmKey: []
CrmTimestamp: []
CrmNonce: []
CrmSignature: []
- OAuthBearer: []
tags:
- name: Metadata
- name: Properties
- name: Sandbox
paths:
/health:
get:
tags: [Metadata]
summary: Check CRM API availability
security: []
responses:
'200':
description: API health
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
/capabilities:
get:
tags: [Metadata]
summary: Return public CRM API capabilities
security: []
responses:
'200':
description: Public capabilities
content:
application/json:
schema:
$ref: '#/components/schemas/CapabilitiesResponse'
/version:
get:
tags: [Metadata]
summary: Return public CRM API version metadata
security: []
responses:
'200':
description: Version metadata
content:
application/json: