Ubikly
API Reference
API Reference

    Ubikly API Quickstart#

    Welcome to the Ubikly API documentation. This guide covers the public REST APIs you can use to interact with your Ubikly organization: read data, create resources, and automate workflows.
    All endpoints return JSON and live under /api/v1.

    Base URL#

    Every request must be sent to your organization's host. Ubikly identifies the organization from the request Host.
    Use your Ubikly hostname:
    https://{subdomain}.ubikly.app
    If your organization has a custom domain, you can use that host instead. Both remain valid.
    https://{custom-domain}

    Authentication#

    The API uses a Bearer token. Send your API key in the Authorization header on every request:
    A missing, invalid, disabled, or expired key returns 401 Unauthorized.

    Getting an API key#

    If you are an admin, create a key in the admin area: Settings → API → Create an API key. Copy it immediately: the full key is shown only once.
    If you are not an admin, ask an admin of your organization to create a key and share it with you.
    Built with