Skip to content

How the Zyelra Developer API works

Understand the agency-scoped Developer API: authentication, scopes, and when to use it for custom apps and integrations.

What this guide covers

Zyelra exposes an agency-scoped HTTP API under /api/v1/developer. External applications authenticate with Bearer API keys and operate only on the agency bound to that key.

This guide explains concepts and workflows. For endpoint parameters, request bodies, and schemas, use the Developer Portal reference at /api (generated from the OpenAPI artifact).

When to use the Developer API

  • Build custom applications or internal tools on top of Zyelra data
  • Sync inventory, leads, stays, or messaging with another system
  • Drive automation platforms (n8n, Make, Zapier, or similar) via HTTP
  • Run bulk or async jobs documented in the API reference

Authentication basics

Create and manage keys in Settings → Developer API. Send Authorization: Bearer <API_KEY> on every request. Agency context always comes from the key — never from a path or query parameter.

  • Keep keys server-side only
  • Grant only the scopes each integration needs
  • Rotate or revoke keys if they may have been exposed

Next steps

Next step

Need endpoint details, parameters, or schemas? Continue in the Developer Portal.

Open the Developer API reference →

Related guides

  • How Zyelra webhooks work

    Register outbound webhook endpoints to receive Zyelra events in your systems and automation workflows.

  • Connect automation platforms to Zyelra

    Use n8n, Make, Zapier, or similar tools with the Zyelra Developer API and webhooks — without relying on official native apps.

  • Integrations overview

    Hub for Zyelra integrations: email, SMS, WhatsApp, calendar, OTAs, guest payments, and AI — plus links to the Developer API and webhooks for custom connections.

  • Get started with Zyelra

    Set up your agency workspace: website, properties, messaging, and the first lead workflow.