Jump to Content

Home API Documentation Recipes API Explorer

API Documentation

Home API Documentation Recipes API Explorer

Getting Started

Get started
API for custom short links
API features
API limits
Live APPS

Examples

Rebrand your first link
Manage your branded links

FAQ

Authentication
Migrate links over workspaces
Integrations
Migrating from Google URL Shortener API

Model

Model overview
Workspaces
Branded short links
Branded domains
Account info
Tags
Retargeting scripts
Resource references
Link Analytics

Authentication

Authentication overview
API Key
OAuth flow

Account

Account identity
Getting account details

Domains

Branded domains
Getting domain details
Listing your domains
Counting your domains
Getting traffic encrypted

Links

Branded short links
Creating a new link
Creating a new Campaign link
Updating a link
Getting link details
Listing your links
Counting your links
Deleting a link
Traffic routing
Native routing
Deep links
Managing OpenGraph Metadata for Links

Errors

HTTP responses
400 - Bad Request
401 - Unauthorized
403 - Invalid format
403 - Already exists
404 - Not found
406 - Not Acceptable
429 - Too Many Requests
500 - Server error
502 - Bad Gateway
503 - Service Unavailable
504 - Gateway Timeout
403 - Limit Exceeded

URL Query Parameters

Query parameters
Templates
Getting query parameters
Creating a query parameter
Updating a query parameter
Delete a query parameter
Presets
Advanced usage
Errors

Tags

Tags
Creating a new tag
Updating a tag
Getting tag details
Listing your tags
Counting your tags
Deleting a tag
Attaching a tag
Detaching a tag

Scripts

Retargeting scripts
Creating a new script
Updating a script
Getting script details
Listing your scripts
Counting your scripts
Deleting a script
Attaching a script
Detaching a script

Click Events

Clickstream

Collections

Resource collections
Paginating collections
Sorting collections

AI Integrations

MCP Server

502 - Bad Gateway

A 502 - Bad Gateway occurs when one of the upstream providers Rebrandly relies on is under maintenance or is experiencing a downtime.

Updated about 1 year ago