Open API Documentation

Welcome to the utm.bar Open API. This API lets you create and manage short links, retrieve click analytics, and automate your link workflows — all over a simple REST interface.

What You Can Do

  • Create short links with custom codes, UTM parameters, and optional expiry
  • List and query all links owned by your team
  • Update metadata — title, description, UTM fields, and expiry
  • Disable / enable / delete links programmatically
  • Read click statistics with daily breakdowns and timezone support

Getting Started

  1. Log in to your Dashboard and open a team
  2. Go to the Developer page and create an API key
  3. Choose the permission scopes your key needs
  4. Use the key in the Authorization header (or X-API-Key) to call the API

Base URL

https://open.utm.bar/v1

Authentication

Pass your API key with every request:

Authorization: Bearer sk_live_xxxx

Or use the alternative header:

X-API-Key: sk_live_xxxx

In This Documentation

  • Quickstart — Create an API key and make your first request in minutes
  • API Reference — Full endpoint reference with request/response examples

Need Help?

Open an issue on GitHub or contact us through the Dashboard. We read every message.