Skip to content
KynectLocal Docs

Overview

KynectLocal API 1.0.0

Section titled “KynectLocal API 1.0.0”

Multi-tenant franchise platform API. All authenticated endpoints accept either a BearerAuth JWT (admin UI flows) or an ApiKey header (X-API-Key: kl_live_...) for programmatic access.

Informations

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
POST
/v1/auth/login
POST
/v1/auth/refresh
POST
/v1/auth/logout
POST
/v1/auth/tenant-lookup
POST
/v1/auth/forgot-password
POST
/v1/auth/reset-password
GET
/v1/me
PUT
/v1/me
GET
/v1/brands
GET
/v1/brands/{brandId}
PUT
/v1/brands/{brandId}
GET
/v1/brands/{brandId}/my-role
GET
/v1/brands/{brandId}/license
GET
/v1/brands/{brandId}/url-policy
PUT
/v1/brands/{brandId}/url-policy
GET
/v1/brands/{brandId}/lead-counts
GET
/v1/brands/{brandId}/locations
POST
/v1/brands/{brandId}/locations
GET
/v1/brands/{brandId}/locations/{locationId}
PUT
/v1/brands/{brandId}/locations/{locationId}
GET
/v1/brands/{brandId}/locations/{locationId}/restore
POST
/v1/brands/{brandId}/locations/{locationId}/location-path
GET
/v1/brands/{brandId}/locations/{locationId}/page-status
GET
/v1/brands/{brandId}/users
GET
/v1/brands/{brandId}/users/{userId}
DELETE
/v1/brands/{brandId}/users/{userId}
PUT
/v1/brands/{brandId}/users/{userId}/role
PUT
/v1/brands/{brandId}/users/{userId}/locations
PUT
/v1/brands/{brandId}/users/{userId}/reset-password
GET
/v1/brands/{brandId}/invitations
POST
/v1/brands/{brandId}/invitations
GET
/v1/brands/{brandId}/invitations/{invitationId}
PUT
/v1/brands/{brandId}/invitations/{invitationId}/resend
GET
/v1/brands/{brandId}/profile/{locationId}
PUT
/v1/brands/{brandId}/profile/{locationId}
GET
/v1/brands/{brandId}/profile/{locationId}/readiness
GET
/v1/brands/{brandId}/profile/{locationId}/holiday-hours
POST
/v1/brands/{brandId}/profile/{locationId}/holiday-hours
PUT
/v1/brands/{brandId}/profile/{locationId}/holiday-hours/{id}
DELETE
/v1/brands/{brandId}/profile/{locationId}/holiday-hours/{id}
GET
/v1/brands/{brandId}/services
GET
/v1/brands/{brandId}/locations/{locationId}/services
POST
/v1/brands/{brandId}/locations/{locationId}/services
PUT
/v1/brands/{brandId}/locations/{locationId}/services/{serviceId}
DELETE
/v1/brands/{brandId}/locations/{locationId}/services/{serviceId}
GET
/v1/brands/{brandId}/content/items
GET
/v1/brands/{brandId}/content/items/{type}/{slug}
GET
/v1/brands/{brandId}/content/{itemId}
GET
/v1/brands/{brandId}/seo
PUT
/v1/brands/{brandId}/seo
GET
/v1/brands/{brandId}/seo/redirects
POST
/v1/brands/{brandId}/seo/redirects
PUT
/v1/brands/{brandId}/seo/redirects/{redirectId}
DELETE
/v1/brands/{brandId}/seo/redirects/{redirectId}
GET
/v1/brands/{brandId}/seo/locations/{locationId}/seo
PUT
/v1/brands/{brandId}/seo/locations/{locationId}/seo
GET
/v1/brands/{brandId}/email-settings
PUT
/v1/brands/{brandId}/email-settings
GET
/v1/brands/{brandId}/email-settings/locations/{locationId}
PUT
/v1/brands/{brandId}/email-settings/locations/{locationId}
GET
/v1/brands/{brandId}/forms
POST
/v1/brands/{brandId}/forms
GET
/v1/brands/{brandId}/forms/{formId}
PUT
/v1/brands/{brandId}/forms/{formId}
DELETE
/v1/brands/{brandId}/forms/{formId}
GET
/v1/brands/{brandId}/leads
GET
/v1/brands/{brandId}/leads/{leadId}
PUT
/v1/brands/{brandId}/leads/{leadId}/status
GET
/v1/brands/{brandId}/media
POST
/v1/brands/{brandId}/media
DELETE
/v1/brands/{brandId}/media/{mediaId}
PATCH
/v1/brands/{brandId}/media/{mediaId}
GET
/v1/brands/{brandId}/locations/{locationId}/media
POST
/v1/brands/{brandId}/locations/{locationId}/media
DELETE
/v1/brands/{brandId}/locations/{locationId}/media/{mediaId}
GET
/v1/brands/{brandId}/events
POST
/v1/brands/{brandId}/events
PUT
/v1/brands/{brandId}/events/{eventId}
DELETE
/v1/brands/{brandId}/events/{eventId}
GET
/v1/brands/{brandId}/posts
POST
/v1/brands/{brandId}/posts
GET
/v1/brands/{brandId}/posts/{postId}
PUT
/v1/brands/{brandId}/posts/{postId}
DELETE
/v1/brands/{brandId}/posts/{postId}
GET
/v1/brands/{brandId}/integrations
POST
/v1/brands/{brandId}/integrations
GET
/v1/brands/{brandId}/integrations/{integrationId}
POST
/v1/brands/{brandId}/integrations/{integrationId}/disconnect
GET
/v1/brands/{brandId}/revenue-settings
GET
/v1/brands/{brandId}/locations/{locationId}/revenue-settings
PUT
/v1/brands/{brandId}/locations/{locationId}/revenue-settings
GET
/v1/brands/{brandId}/custom-fields
POST
/v1/brands/{brandId}/custom-fields
PUT
/v1/brands/{brandId}/custom-fields/{fieldId}
DELETE
/v1/brands/{brandId}/custom-fields/{fieldId}
GET
/v1/brands/{brandId}/locations/{locationId}/custom-fields
PUT
/v1/brands/{brandId}/locations/{locationId}/custom-fields
GET
/v1/brands/{brandId}/promotions
GET
/v1/brands/{brandId}/locations/{locationId}/promotions
POST
/v1/brands/{brandId}/locations/{locationId}/promotions
PUT
/v1/brands/{brandId}/locations/{locationId}/promotions/{promotionId}
DELETE
/v1/brands/{brandId}/locations/{locationId}/promotions/{promotionId}
GET
/v1/brands/{brandId}/billing/subscription
GET
/v1/brands/{brandId}/billing/entitlements
GET
/v1/brands/{brandId}/sites
POST
/v1/brands/{brandId}/sites
PUT
/v1/brands/{brandId}/sites/{siteId}
DELETE
/v1/brands/{brandId}/sites/{siteId}
PUT
/v1/brands/{brandId}/sites/{siteId}/primary
GET
/v1/brands/{brandId}/sites/{siteId}/nav
PUT
/v1/brands/{brandId}/sites/{siteId}/nav
GET
/v1/brands/{brandId}/sites/{siteId}/nav-preview
GET
/public/brands/{brandId}/locations/map-pins
GET
/public/forms/{formSlug}
POST
/public/forms/{formSlug}/submit
GET
/public/nav
GET
/public/events/active
GET
/public/blog-json/{brandId}
POST
Lead submitted via a public form WEBHOOK

Authentication

Section titled “ Authentication ”

BearerAuth

Section titled “BearerAuth ”

Short-lived JWT access token (RS256, 15-min TTL) obtained from POST /v1/auth/login. Pass as Authorization: Bearer .

Security scheme type: http

Bearer format: JWT

ApiKey

Section titled “ApiKey ”

Brand-scoped API key with prefix kl_live_. Issued per-brand via the admin UI (Settings → API Keys). Authorises all routes scoped to that brand. Machine-to-machine access is currently in private beta — contact your account representative to enable API key issuance for your brand.

Security scheme type: apiKey

Header parameter name: X-API-Key