# Rebrandly for Developers Documentation > Efficiently manage high-volume short links with the Rebrandly API and our MCP server. Create millions of branded short links for all your customer communications—experience unrivaled reliability, security, and performance. ## Guides - [Get started](https://developers.rebrandly.com/docs/get-started.md): Make your first API call and create a branded short link in minutes - [SDKs and client libraries](https://developers.rebrandly.com/docs/sdks.md): Official Rebrandly client libraries for Python and Node.js, with installation instructions and basic usage examples. - [OpenAPI spec](https://developers.rebrandly.com/docs/openapi-spec.md) - [Introduction to the Rebrandly API](https://developers.rebrandly.com/docs/api-custom-url-shortener.md): What the Rebrandly API is, how it works, and where to start. - [API features](https://developers.rebrandly.com/docs/api-features.md): What you can do with the Rebrandly API - [API limits](https://developers.rebrandly.com/docs/api-limits.md): Understanding account limits and the Rebrandly API rate limits - [Extended workspaces](https://developers.rebrandly.com/docs/extended-workspaces.md): Extended workspaces are a customizable plan tier for high-volume API use cases requiring increased link capacity and higher rate limits. - [Live apps](https://developers.rebrandly.com/docs/live-apps.md): Rebrandly Web API is currently consumed by over 20,000 developers worldwide for internal and external projects - [Code examples for creating a link](https://developers.rebrandly.com/docs/create-your-first-link.md): Create a branded short link using the Rebrandly API in your language of choice - [Manage your branded links](https://developers.rebrandly.com/docs/list-your-links.md): How to manage and organize your branded short links - [How the MCP works](https://developers.rebrandly.com/docs/mcp-server.md) - [Quick start for MCP](https://developers.rebrandly.com/docs/quick-start-for-mcp.md): Instructions for those who want to jump right in with Claude Desktop - [MCP Installation](https://developers.rebrandly.com/docs/mcp-installation.md): Step-by-step guides for installing the Rebrandly MCP server on different AI assistants. - [MCP troubleshooting](https://developers.rebrandly.com/docs/mcp-troubleshooting.md): Solutions for common issues when setting up and using the Rebrandly MCP server. - [MCP tools reference](https://developers.rebrandly.com/docs/mcp-tools-reference.md): A catalog of Rebrandly MCP tools organized by category. - [Authentication](https://developers.rebrandly.com/docs/authentication.md) - [Migrate links over workspaces](https://developers.rebrandly.com/docs/migrate-links-over-teams.md) - [Integrations](https://developers.rebrandly.com/docs/integrations.md) - [Migrating from Google URL Shortener API](https://developers.rebrandly.com/docs/migrating-from-google-shortener-api.md): A walkthrough to adapt your existing URL shortening application - [Model overview](https://developers.rebrandly.com/docs/model-overview.md) - [Workspaces](https://developers.rebrandly.com/docs/workspaces.md): Rebrandly links, together with tags and retargeting scripts attached to them, exist in a specific Workspace (ex Team). Workspaces allow you to organize your resources and share them with your teammates. - [Branded short links](https://developers.rebrandly.com/docs/link-entity.md): Branded short links are the main Rebrandly resource. You can create, update and delete your collection of branded short links. Links can be viewed individually or as a list. - [Branded domains](https://developers.rebrandly.com/docs/branded-domain-model.md): Branded domains allow you to create your custom link shortener. You can list all the domains you own, and choose the one that best fits your branded short links. - [Account info](https://developers.rebrandly.com/docs/account-model.md): Accounts are designed to provide your application with an identity. - [Tags](https://developers.rebrandly.com/docs/tag-model.md): Tags are used to better organize your branded links collection - [Retargeting scripts](https://developers.rebrandly.com/docs/retargeting-cripts.md): Retargeting scripts are used to execute custom javascript snippets during the redirection process - [Resource references](https://developers.rebrandly.com/docs/resource-objects.md): Resource References are objects used to link resources together, in order to allow navigation between them. - [Link Analytics](https://developers.rebrandly.com/docs/link-analytics.md): Get info about the incoming traffic on your links - [Authentication overview](https://developers.rebrandly.com/docs/authentication-overview.md) - [API Key](https://developers.rebrandly.com/docs/api-key-authentication.md) - [OAuth flow](https://developers.rebrandly.com/docs/oauth-flow.md) - [Account identity](https://developers.rebrandly.com/docs/account-identity.md) - [Getting account details](https://developers.rebrandly.com/docs/getting-account-details.md) - [Branded domains](https://developers.rebrandly.com/docs/branded-domains.md) - [Getting domain details](https://developers.rebrandly.com/docs/getting-single-domain-details.md) - [Listing your domains](https://developers.rebrandly.com/docs/listing-your-domains-collection.md) - [Counting your domains](https://developers.rebrandly.com/docs/counting-your-domains.md) - [Getting traffic encrypted](https://developers.rebrandly.com/docs/getting-traffic-encrypted.md) - [Domain aliasing with Node.js/Express](https://developers.rebrandly.com/docs/domain-aliasing-nodejs-express.md): How to serve Rebrandly branded short links from your own Express web server using the rebrandly-express middleware package. - [Branded short links](https://developers.rebrandly.com/docs/links-overview.md) - [Creating a new link](https://developers.rebrandly.com/docs/create-a-new-link.md) - [Creating a new Campaign link](https://developers.rebrandly.com/docs/creating-a-new-link-copy.md): To meet customer needs for faster link creation and overcome the 10/second API call limit of standard Rebrandly plans, our API model allows developers to implement special flows in their scripts to match high availability and performance requirements and access an extended feature set. A Campaign link can only be created inside a Campaign (formerly Extended) Workspace. - [Updating a link](https://developers.rebrandly.com/docs/update-a-link.md) - [Getting link details](https://developers.rebrandly.com/docs/get-link-details.md) - [Listing your links](https://developers.rebrandly.com/docs/list-links.md) - [Counting your links](https://developers.rebrandly.com/docs/counting-your-links.md) - [Deleting a link](https://developers.rebrandly.com/docs/delete-a-link.md) - [Traffic routing](https://developers.rebrandly.com/docs/advanced-link-options.md): how to define advanced routing behavior for a link - [Set up mobile deep linking](https://developers.rebrandly.com/docs/native-routing.md): Configure mobile deep linking on Rebrandly links via the dashboard - [Mobile deep linking](https://developers.rebrandly.com/docs/deep-links.md): How Rebrandly links can open specific screens inside iOS and Android apps - [Managing OpenGraph Metadata for Links](https://developers.rebrandly.com/docs/managing-opengraph-metadata-for-links.md) - [Creating links at scale for SMS and campaigns](https://developers.rebrandly.com/docs/high-volume-link-creation.md): How to use the Rebrandly high-volume API to batch-create branded links for SMS campaigns, transactional email, and other high-throughput integrations. - [High-volume API: hosts and routing](https://developers.rebrandly.com/docs/high-volume-api-hosts.md): How the Rebrandly API and high-volume API hosts differ in rate limits, and a WAF quirk that affects high-volume requests with script tags. - [High-volume API link limitations](https://developers.rebrandly.com/docs/high-volume-api-link-limitations.md): API fields that are silently dropped for high-volume API links, and sub-resource endpoints that return errors on high-volume API link IDs. - [Create multiple links with the same destination URL](https://developers.rebrandly.com/docs/creating-multiple-links-same-destination-url-bulk.md): A dedicated endpoint for creating large numbers of links with the same destination URL. Available on specific subscriptions. - [HTTP responses](https://developers.rebrandly.com/docs/http-responses.md) - [400 - Bad Request](https://developers.rebrandly.com/docs/400-bad-request.md) - [401 - Unauthorized](https://developers.rebrandly.com/docs/401-unauthorized.md) - [403 - Invalid format](https://developers.rebrandly.com/docs/validation-errors.md) - [403 - Already exists](https://developers.rebrandly.com/docs/403-already-exists-errors.md) - [404 - Not found](https://developers.rebrandly.com/docs/404-not-found-errors.md) - [406 - Not Acceptable](https://developers.rebrandly.com/docs/406-not-acceptable.md) - [429 - Too Many Requests](https://developers.rebrandly.com/docs/429-too-many-requests.md) - [500 - Server error](https://developers.rebrandly.com/docs/500-server-error.md) - [502 - Bad Gateway](https://developers.rebrandly.com/docs/502-bad-gateway.md) - [503 - Service Unavailable](https://developers.rebrandly.com/docs/503-maintenance.md) - [504 - Gateway Timeout](https://developers.rebrandly.com/docs/504-gateway-timeout.md) - [403 - Limit Exceeded](https://developers.rebrandly.com/docs/403-limit-exceeded.md) - [Troubleshooting](https://developers.rebrandly.com/docs/troubleshooting.md): Common errors and fixes for the Rebrandly API: authentication failures, rate limiting, access errors, and high-volume-specific issues. - [Query parameters](https://developers.rebrandly.com/docs/query-parameter.md) - [Templates](https://developers.rebrandly.com/docs/templates.md) - [Getting query parameters](https://developers.rebrandly.com/docs/getting-query-parameters.md) - [Creating a query parameter](https://developers.rebrandly.com/docs/creating-query-parameters.md) - [Updating a query parameter](https://developers.rebrandly.com/docs/updating-a-query-parameter.md) - [Delete a query parameter](https://developers.rebrandly.com/docs/delete-a-query-parameter.md) - [Presets](https://developers.rebrandly.com/docs/presets.md) - [Creating a preset](https://developers.rebrandly.com/docs/creating-a-preset-1.md) - [Populating a preset](https://developers.rebrandly.com/docs/updating-a-preset.md) - [Getting presets list](https://developers.rebrandly.com/docs/getting-presets-list.md) - [Delete a preset](https://developers.rebrandly.com/docs/delete-a-preset.md) - [Advanced usage](https://developers.rebrandly.com/docs/advanced-usage.md) - [Errors](https://developers.rebrandly.com/docs/errors.md) - [Tags](https://developers.rebrandly.com/docs/tags.md) - [Creating a new tag](https://developers.rebrandly.com/docs/creating-a-new-tag.md) - [Updating a tag](https://developers.rebrandly.com/docs/updating-a-tag.md) - [Getting tag details](https://developers.rebrandly.com/docs/getting-tag-details.md) - [Listing your tags](https://developers.rebrandly.com/docs/listing-your-tags.md) - [Counting your tags](https://developers.rebrandly.com/docs/counting-your-tags.md) - [Deleting a tag](https://developers.rebrandly.com/docs/deleting-a-tag.md) - [Attaching a tag](https://developers.rebrandly.com/docs/attaching-a-tag.md) - [Detaching a tag](https://developers.rebrandly.com/docs/detaching-a-tag.md) - [Retargeting scripts](https://developers.rebrandly.com/docs/retargeting-scripts.md) - [Creating a new script](https://developers.rebrandly.com/docs/creating-a-new-script.md) - [Updating a script](https://developers.rebrandly.com/docs/updating-a-script.md) - [Getting script details](https://developers.rebrandly.com/docs/getting-script-details.md) - [Listing your scripts](https://developers.rebrandly.com/docs/listing-your-scripts.md) - [Counting your scripts](https://developers.rebrandly.com/docs/counting-your-scripts.md) - [Deleting a script](https://developers.rebrandly.com/docs/deleting-a-script.md) - [Attaching a script](https://developers.rebrandly.com/docs/attaching-a-script.md) - [Detaching a script](https://developers.rebrandly.com/docs/detaching-a-script.md) - [Clickstream](https://developers.rebrandly.com/docs/click-events.md): Get a stream of click events that enables real-time processing of traffic on branded links - [Clickstream overview](https://developers.rebrandly.com/docs/clickstream-webhooks.md): Clickstream is a real-time event stream that forwards click data from your Rebrandly links to external systems for processing, analytics, or storage. - [Clickstream webhook setup](https://developers.rebrandly.com/docs/clickstream-webhook-setup.md): Configure Rebrandly Clickstream to stream click events to a REST API endpoint via webhook. - [Clickstream S3 setup](https://developers.rebrandly.com/docs/clickstream-s3-setup.md): Configure Rebrandly Clickstream to deliver click events to an AWS S3 bucket. - [How conversion tracking works](https://developers.rebrandly.com/docs/conversion-tracking-overview.md): Understanding Rebrandly's click-based attribution model. - [Getting started with conversion tracking](https://developers.rebrandly.com/docs/quickstart.md): Install the conversion tracking SDK, verify it's working, and fire your first event. - [Install conversion tracking with Google Tag Manager](https://developers.rebrandly.com/docs/ct-gtm-installation.md): Set up Rebrandly conversion tracking in your GTM container using a custom HTML tag and data layer events. - [Install the conversion tracking script](https://developers.rebrandly.com/docs/script-configuration.md): Add the event tracking script to your website. - [Custom events reference](https://developers.rebrandly.com/docs/custom-events.md): Record conversion events using rbly.convert() and custom behavioral events using rbly.track() — parameters, response shapes, UTM behavior, and examples - [Resource collections](https://developers.rebrandly.com/docs/resource-collections.md) - [Paginating collections](https://developers.rebrandly.com/docs/understanding-pagination.md) - [Sorting collections](https://developers.rebrandly.com/docs/understanding-sorting.md) - [Security disclosure policy](https://developers.rebrandly.com/docs/security-disclosure-policy.md): Report vulnerabilities to security@rebrandly.com ## API Reference - [Create a New Link](https://developers.rebrandly.com/reference/createlink.md): Creates a new branded short link in the specified workspace. **Authorization:** - Requires valid `apikey` header - Requires `Workspace` header to specify the workspace **Validation:** - `destination` must be a valid URL - `domainId` must reference a verified domain shared with the workspace - `slashtag` must be unique for the domain (auto-generated if not provided) - `slashtag` length must comply with domain settings **Features:** - `links.notes` feature allows `description` field - Link TTL is calculated based on workspace features - [List Links](https://developers.rebrandly.com/reference/getlinks.md): Retrieves a paginated list of links in the specified workspace. **Authorization:** Requires authenticated user with workspace access. - [Get Link](https://developers.rebrandly.com/reference/getlink.md): Get single link details by ID. **Requires:** Authenticated user with workspace access. **Authorization:** - [Update Link](https://developers.rebrandly.com/reference/update-link-endpoint.md): Update link properties. **Requires:** Authenticated user with workspace access. **Authorization:** **Blocked by:** - Link with status=3 (deleted) - Revoked workspace - Revoked domain (if changing domain) - Link type change (cannot change link types) - [Delete Link](https://developers.rebrandly.com/reference/delete-link-endpoint.md): Soft delete a link. The link will no longer redirect. **Requires:** Authenticated user with workspace access. **Authorization:** **Blocked by:** Link already deleted (status=3). - [Count Links](https://developers.rebrandly.com/reference/countlinks.md): Get total count of links with optional filtering. **Requires:** Authenticated user with workspace access. **Authorization:** - [List Link Tags](https://developers.rebrandly.com/reference/getlinktags.md): List all tags assigned to a link. **Requires:** Authenticated user with workspace access. **Blocked by:** Link deleted (status=3). **Workspace Type:** Classic or Gallery workspaces only. - [Assign Tag to Link](https://developers.rebrandly.com/reference/attachtag.md): Add a tag to a link for categorization. **Requires:** - Feature: `links.tags` **Blocked by:** - Link deleted (status=3) - Revoked workspace - Revoked domain **Workspace Type:** Classic or Gallery workspaces only. - [Remove Tag from Link](https://developers.rebrandly.com/reference/detachtag.md): Remove a tag assignment from a link. **Blocked by:** - Link deleted (status=3) - Revoked workspace - [List Link Scripts](https://developers.rebrandly.com/reference/getlinkscripts.md): List all scripts/pixels attached to a link. **Requires:** Authenticated user with workspace access. **Blocked by:** Link deleted (status=3). **Workspace Type:** Classic or Gallery workspaces only. - [Attach Script to Link](https://developers.rebrandly.com/reference/attachscript.md): Attach a script/pixel to a link for tracking purposes. **Requires:** - Feature: `links.scripts` **Blocked by:** - Link deleted (status=3) - Revoked workspace - Revoked domain **Workspace Type:** Classic or Gallery workspaces only. - [Detach Script from Link](https://developers.rebrandly.com/reference/detachscript.md): Remove a script from a link. **Blocked by:** - Link deleted (status=3) - Revoked workspace - [Bulk Create Links](https://developers.rebrandly.com/reference/bulkcreatelinks.md): Create multiple links in a single request. **Requires:** - Feature: `links.bulk` - Workspace type: Extended only **Blocked by:** Revoked workspace. **Limits:** Up to 10 links per request (configurable). - [Bulk Create/Update Links](https://developers.rebrandly.com/reference/bulkupsertlinks.md): Create or update multiple links (same as POST). **Requires:** - Feature: `links.bulk` - Workspace type: Extended only **Blocked by:** Revoked workspace. - [Search Links](https://developers.rebrandly.com/reference/searchlinks.md): Search for links with advanced filtering by term, domain, tag, and more. **Requires:** Authenticated user with workspace access. **Authorization:** - [Search Links (POST)](https://developers.rebrandly.com/reference/searchlinkspost.md): Search for links with advanced filtering via POST body. Useful when filter parameters are too complex for query strings. **Requires:** Authenticated user with workspace access. **Authorization:** - [Count Search Results](https://developers.rebrandly.com/reference/countsearchlinks.md): Get count of links matching search criteria without returning the links. **Requires:** Authenticated user with workspace access. **Authorization:** - [Count Search Results (POST)](https://developers.rebrandly.com/reference/countsearchlinkspost.md): Get count of links matching search criteria via POST body. **Requires:** Authenticated user with workspace access. **Authorization:** - [Get Link OpenGraph](https://developers.rebrandly.com/reference/getlinkopengraph.md): Get OpenGraph metadata for a link (title, description, image). Used for social media preview customization. **Requires:** Authenticated user with workspace access. **Blocked by:** Link deleted (status=3). **Workspace Type:** Classic or Gallery workspaces only. - [Set Link OpenGraph](https://developers.rebrandly.com/reference/setlinkopengraph.md): Set custom OpenGraph metadata for a link to control social media previews. **Requires:** - Feature: `links.opengraph` **Blocked by:** - Link deleted (status=3) - Revoked workspace - Revoked domain **Workspace Type:** Classic or Gallery workspaces only. - [Delete Link OpenGraph](https://developers.rebrandly.com/reference/deletelinkopengraph.md): Remove custom OpenGraph metadata from a link. Social previews will revert to destination page metadata. **Blocked by:** - Link deleted (status=3) - Revoked workspace - [Toggle Link Favourite](https://developers.rebrandly.com/reference/togglelinkfavourite.md): Mark or unmark a link as favourite for quick access. **Blocked by:** - Link deleted (status=3) - Revoked workspace - Revoked domain **Workspace Type:** Classic workspaces only. - [List Link Apps](https://developers.rebrandly.com/reference/listlinkapps.md): List apps attached to a link. - [Count Link Apps](https://developers.rebrandly.com/reference/countlinkapps.md): Count apps attached to a link. - [Get Link App](https://developers.rebrandly.com/reference/getlinkapp.md): Get details of a specific app attached to a link. - [Attach App to Link](https://developers.rebrandly.com/reference/attachapptolink.md): Attach an app to a link. **Requires:** `links.apps` feature flag. - [Detach App from Link](https://developers.rebrandly.com/reference/detachappfromlink.md): Detach an app from a link. - [List Domains](https://developers.rebrandly.com/reference/getshareddomains.md): List all domains shared with the workspace. **Requires:** Authenticated user with workspace access. - [Get Domain](https://developers.rebrandly.com/reference/getshareddomain.md): Get details of a specific domain shared with the workspace. **Requires:** Authenticated user with workspace access. - [Count Domains](https://developers.rebrandly.com/reference/countshareddomains.md): Get count of domains shared with the workspace. **Requires:** Authenticated user with workspace access. - [List Workspace Domains](https://developers.rebrandly.com/reference/listworkspacedomains.md): List all domains available in the workspace. - [Count Workspace Domains](https://developers.rebrandly.com/reference/countworkspacedomains.md) - [Get Workspace Domain](https://developers.rebrandly.com/reference/getworkspacedomain.md) - [Share Domain with Workspace](https://developers.rebrandly.com/reference/shareworkspacedomain.md): Add a domain to the workspace so it can be used for creating links. **Restrictions:** - System domains cannot be added to extended workspaces. - [Unshare Domain from Workspace](https://developers.rebrandly.com/reference/unshareworkspacedomain.md): Remove a domain from the workspace. - [Share Domain with Workspace](https://developers.rebrandly.com/reference/sharedomain.md): Add/share an existing account domain to the workspace. **Blocked by:** - Revoked domain - System domains in extended workspaces - [Remove Domain from Workspace](https://developers.rebrandly.com/reference/unsharedomain.md): Unshare a domain from the workspace. The domain will no longer be available for creating links, but existing links are not affected. - [Get Domain WHOIS Data](https://developers.rebrandly.com/reference/getdomaindata.md): Get stored WHOIS data for the account. - [Save Domain WHOIS Data](https://developers.rebrandly.com/reference/savedomaindata.md): Save WHOIS data for domain registration. - [Delete Tag](https://developers.rebrandly.com/reference/deletetag.md): Delete a tag and remove it from all associated links. - [Get Tag](https://developers.rebrandly.com/reference/tag-details-endpoint.md): Get details of a specific tag by ID. **Requires:** Authenticated user with workspace access. - [Update Tag](https://developers.rebrandly.com/reference/update-tag-endpoint.md): Update tag properties (name, color). **Requires:** - Feature: `links.tags` - [List Tags](https://developers.rebrandly.com/reference/gettags.md): List all tags in the workspace with optional filtering by name. **Requires:** Authenticated user with workspace access. - [Create Tag](https://developers.rebrandly.com/reference/create-tag-endpoint.md): Create a new tag in the workspace for categorizing links. **Requires:** - Feature: `links.tags` - [Count Tags](https://developers.rebrandly.com/reference/counttags.md): Get total count of tags in the workspace. **Requires:** Authenticated user with workspace access. - [List Tag Links](https://developers.rebrandly.com/reference/listtaglinks.md): List all links associated with a specific tag. **Requires:** Authenticated user with workspace access. **Authorization:** - [Count Tag Links](https://developers.rebrandly.com/reference/counttaglinks.md): Count links associated with a specific tag. **Requires:** Authenticated user with workspace access. **Authorization:** - [Get Account](https://developers.rebrandly.com/reference/getaccount.md): Get current authenticated user's account details. - [Get Subscription History](https://developers.rebrandly.com/reference/getaccountsubscriptions.md): Get the subscription history (profile changes) for the current account. - [Get Account Stats](https://developers.rebrandly.com/reference/getaccountstats.md): Get account statistics (currently returns empty object - reserved for future use). - [Get Billing Data](https://developers.rebrandly.com/reference/getbillingdata.md): Get the billing data (address, tax info) for the current account. **Feature:** If `extra.hide_financials` feature is enabled, this returns 403. - [Update Billing Data](https://developers.rebrandly.com/reference/updatebillingdata.md): Update billing data for the account. - [List Account Domains](https://developers.rebrandly.com/reference/listaccountdomains.md): List all domains owned by the account. **Note:** These are domains at the account level (purchased/registered domains), not workspace-level domain assignments. - [Create Domain](https://developers.rebrandly.com/reference/createaccountdomain.md): Register a new domain for the account. **Features:** - `domains.whitelabeled.fallback`: Required for custom404 - `domains.whitelabeled.homepage`: Required for customHomepage - `domains.validation.skip`: Skip TLD validation - [Count Account Domains](https://developers.rebrandly.com/reference/countaccountdomains.md): Get the count of domains owned by the account. - [Search Account Domains](https://developers.rebrandly.com/reference/searchaccountdomains.md): Search domains in the account. - [Get Account Domain](https://developers.rebrandly.com/reference/getaccountdomain.md): Get details of a specific domain owned by the account. - [Update Account Domain](https://developers.rebrandly.com/reference/updateaccountdomain.md): Update domain settings. **Entitlement Check:** Domain must not be revoked. - [Delete Account Domain](https://developers.rebrandly.com/reference/deleteaccountdomain.md): Delete a domain from the account. **Note:** Only USER type domains owned by the account can be deleted. - [Enable Domain Auto-Renewal](https://developers.rebrandly.com/reference/enabledomainautorenew.md): Enable automatic renewal for the domain. - [Disable Domain Auto-Renewal](https://developers.rebrandly.com/reference/disabledomainautorenew.md): Disable automatic renewal for the domain. - [Set Domain Homepage Routing](https://developers.rebrandly.com/reference/setdomainhomepagerouting.md): Configure custom homepage routing for the domain. **Feature Required:** `domains.whitelabeled.homepage` - [Disable Domain Homepage Routing](https://developers.rebrandly.com/reference/disabledomainhomepagerouting.md): Disable custom homepage routing for the domain. **Feature Required:** `domains.whitelabeled.homepage` - [Set Domain Fallback Routing](https://developers.rebrandly.com/reference/setdomainfallbackrouting.md): Configure custom 404/fallback routing for the domain. **Feature Required:** `domains.whitelabeled.fallback` - [Disable Domain Fallback Routing](https://developers.rebrandly.com/reference/disabledomainfallbackrouting.md): Disable custom fallback routing for the domain. **Feature Required:** `domains.whitelabeled.fallback` - [List Domain Subdomains](https://developers.rebrandly.com/reference/listdomainsubdomains.md): List all subdomains of a parent domain. - [Count Domain Subdomains](https://developers.rebrandly.com/reference/countdomainsubdomains.md): Get count of subdomains for a parent domain. - [Count Domain Search Results](https://developers.rebrandly.com/reference/countdomainsearchresults.md): Get the count of domains matching search criteria. - [Get Domain Click Statistics](https://developers.rebrandly.com/reference/getdomainclicks.md): Get click analytics for a specific domain. **Purpose:** Retrieve aggregated click statistics for a domain. **Requires:** `metrics.advanced` feature flag. - [Get Domain Segment Statistics](https://developers.rebrandly.com/reference/getdomainsegments.md): Alias for /account/domains/{domain_id}/clicks - get click analytics for a domain. **Requires:** `metrics.advanced` feature flag. - [List Domain Workspaces](https://developers.rebrandly.com/reference/listdomainworkspaces.md): List workspaces that have this domain attached. **Purpose:** View all workspaces using a specific domain. - [Count Domain Workspaces](https://developers.rebrandly.com/reference/countdomainworkspaces.md): Count workspaces that have this domain attached. - [List App Keys](https://developers.rebrandly.com/reference/listappkeys.md): List all app keys (credentials) for the account. - [Count App Keys](https://developers.rebrandly.com/reference/countappkeys.md): Count all app keys for the account. - [Logout (Invalidate JWT Token)](https://developers.rebrandly.com/reference/logout.md): Invalidate the current JWT access token, preventing further use. The token's `jti` claim is added to a Redis blacklist with a TTL matching the token's remaining lifetime. Subsequent requests using the same token will receive a 401 response. **Requires:** Bearer token authentication (Authorization header). - [List Workspaces](https://developers.rebrandly.com/reference/getsharedworkspaces.md): List workspaces the authenticated user has access to. - [Create Workspace](https://developers.rebrandly.com/reference/createworkspace.md): Create a new workspace. **Feature Flags:** - `links.expiration`: Required if expiration.ttl provided - `links.extended`: Required if type is "extended" - [Count Workspaces](https://developers.rebrandly.com/reference/countworkspaces.md): Get total count of workspaces matching filters. - [Get Workspace](https://developers.rebrandly.com/reference/getworkspace.md): Get single workspace details with click/session statistics. - [Update Workspace](https://developers.rebrandly.com/reference/updateworkspace.md): Update workspace details. **Blocked by:** Workspace revoked. - [Delete or Leave Workspace](https://developers.rebrandly.com/reference/deleteworkspace.md): Delete workspace (if owner) or leave workspace (if non-owner). **Behavior:** - If owner: Deletes entire workspace (soft delete if `trash=true`) - If non-owner: Detaches user as teammate from workspace - [Delete Workspace TTL](https://developers.rebrandly.com/reference/deleteworkspacettlbyid.md): Remove the default TTL (time-to-live) setting from a workspace. **Blocked by:** Workspace revoked. - [Get Workspace Conversion Tracking Settings](https://developers.rebrandly.com/reference/getworkspaceconversiontracking.md): Get conversion tracking configuration for a workspace. **Requires Feature:** `extra.conversion_tracking` Returns the current conversion tracking settings. If conversion tracking has not been configured for this workspace, returns the default disabled state. - [Update Workspace Conversion Tracking Settings](https://developers.rebrandly.com/reference/updateworkspaceconversiontracking.md): Enable or disable conversion tracking and configure the attribution window for a workspace. **Requires Feature:** `extra.conversion_tracking` **Behavior:** - When `enabled=true`: Activates conversion tracking. If `attributionWindow` is not provided, defaults to 30 days. - When `enabled=false`: Disables conversion tracking. The `attributionWindow` is preserved (from body if provided, otherwise from the previous DB value, otherwise `null`). - [Get Workspace Owner Features](https://developers.rebrandly.com/reference/getworkspacefeatures.md): List features available to the workspace owner's account. Includes standard features, profile features, and revoked features. - [Invite Users to Workspace](https://developers.rebrandly.com/reference/invitetoworkspace.md): Send invites to multiple users for a workspace. **Limits:** 100 invites per day. - [List Account Workspaces](https://developers.rebrandly.com/reference/listaccountworkspaces.md): List all workspaces owned by the account. - [Create Account Workspace](https://developers.rebrandly.com/reference/createaccountworkspace.md): Create a new workspace owned by the account. **Note:** Creating workspaces with `type: "gallery"` via this endpoint is deprecated. Use `POST /v1/internal/account/{account_id}/workspaces` for gallery workspace creation. - [Count Account Workspaces](https://developers.rebrandly.com/reference/countaccountworkspaces.md): Count workspaces owned by the account. - [Get Account Workspace](https://developers.rebrandly.com/reference/getaccountworkspace.md): Get details of a specific workspace. - [Update Account Workspace](https://developers.rebrandly.com/reference/updateaccountworkspace.md): Update a workspace. - [Delete Account Workspace](https://developers.rebrandly.com/reference/deleteaccountworkspace.md): Delete a workspace. - [Invite to Workspace](https://developers.rebrandly.com/reference/invitetoaccountworkspace.md): Send invitations to join a workspace. - [Delete Workspace TTL](https://developers.rebrandly.com/reference/deleteworkspacettl.md): Remove the default TTL setting from a workspace. - [List Scripts](https://developers.rebrandly.com/reference/getscripts.md): List all tracking scripts/pixels in the workspace. **Requires:** Authenticated user with workspace access. - [Create Script](https://developers.rebrandly.com/reference/create-script-endpoint.md): Create a new tracking script/pixel in the workspace. **Requires:** - Feature: `links.scripts` - [Get Script](https://developers.rebrandly.com/reference/getscript.md): Get details of a specific script by ID. **Requires:** Authenticated user with workspace access. - [Delete Script](https://developers.rebrandly.com/reference/delete-script-endpoint.md): Delete a script and remove it from all associated links. - [Update Script](https://developers.rebrandly.com/reference/update-script-endpoint.md): Update script properties. **Requires:** - Feature: `links.scripts` - [Count Scripts](https://developers.rebrandly.com/reference/countscripts.md): Get total count of scripts in the workspace. **Requires:** Authenticated user with workspace access. - [Count Link Scripts](https://developers.rebrandly.com/reference/countlinkscripts.md): Get count of scripts attached to a link. **Requires:** Authenticated user with workspace access. **Blocked by:** Link deleted (status=3). - [List Script Links](https://developers.rebrandly.com/reference/listscriptlinks.md): List links that use a specific script. - [Count Script Links](https://developers.rebrandly.com/reference/countscriptlinks.md): Count links that use a specific script. - [List Link Rules](https://developers.rebrandly.com/reference/listlinkrules.md): List all routing rules for a link. Rules determine conditional redirects based on device type, location, time, or platform. **Requires:** Authenticated user with workspace access. **Blocked by:** Link deleted (status=3). - [Create Link Rule](https://developers.rebrandly.com/reference/createlinkrule.md): Add a routing rule to a link for conditional redirects. **Requires:** - Feature: `links.rules` **Blocked by:** - Link deleted (status=3) - Revoked workspace - Revoked domain - [List Rotator Rules](https://developers.rebrandly.com/reference/listrotatorrules.md): List all rotator rules for a link. Rotator rules distribute traffic across multiple destinations based on weight or round-robin. **Requires:** Authenticated user with workspace access. **Blocked by:** Link deleted (status=3). **Link Type:** Rotator links only. - [Create Rotator Rule](https://developers.rebrandly.com/reference/createrotatorrule.md): Create a new rotator rule for traffic distribution. **Blocked by:** - Link deleted (status=3) - Revoked workspace - Revoked domain **Link Type:** Rotator links only. - [Update All Rotator Rules](https://developers.rebrandly.com/reference/updaterotatorrules.md): Replace all rotator rules for the link with a new set. **Blocked by:** - Link deleted (status=3) - Revoked workspace - [Delete All Rotator Rules](https://developers.rebrandly.com/reference/deleterotatorrules.md): Delete all rotator rules for the link. **Blocked by:** - Link deleted (status=3) - Revoked workspace - [Get Rotator Rule](https://developers.rebrandly.com/reference/getrotatorrule.md): Get details of a specific rotator rule. **Requires:** Authenticated user with workspace access. - [Update Rotator Rule](https://developers.rebrandly.com/reference/updaterotatorrule.md): Update a single rotator rule. **Blocked by:** - Link deleted (status=3) - Revoked workspace - [Count Link Rules](https://developers.rebrandly.com/reference/countlinkrules.md): Get the total number of routing rules for a link. **Requires:** Authenticated user with workspace access. **Blocked by:** Link deleted (status=3). - [Get Link Rule](https://developers.rebrandly.com/reference/getlinkrule.md): Get a single routing rule for a link by its public ID. **Requires:** Authenticated user with workspace access. **Blocked by:** Link deleted (status=3). - [Update Link Rule](https://developers.rebrandly.com/reference/updatelinkrule.md): Update an existing routing rule on a link. **Requires:** **Blocked by:** - Link deleted (status=3) - Revoked workspace - Revoked domain - [Delete Link Rule](https://developers.rebrandly.com/reference/deletelinkrule.md): Delete a routing rule from a link. **Requires:** **Blocked by:** - Link deleted (status=3) - Revoked workspace - Revoked domain - [Count Link Tags](https://developers.rebrandly.com/reference/countlinktags.md): Get the total number of tags assigned to a link. **Requires:** Authenticated user with workspace access. **Blocked by:** Link deleted (status=3). **Workspace Type:** Classic or Gallery workspaces only. - [List Workspace Invites](https://developers.rebrandly.com/reference/listworkspaceinvites.md): List all pending invites for the workspace. - [Count Workspace Invites](https://developers.rebrandly.com/reference/countworkspaceinvites.md): Count invites for a workspace filtered by status. - [List Workspace Teammates](https://developers.rebrandly.com/reference/listworkspaceteammates.md): List all teammates in a workspace with their roles and account info. - [Count Workspace Teammates](https://developers.rebrandly.com/reference/countworkspaceteammates.md): Count teammates in a workspace. - [Get Workspace Teammate](https://developers.rebrandly.com/reference/getworkspaceteammate.md): Get details of a specific teammate in a workspace. - [Add or Update Workspace Teammate](https://developers.rebrandly.com/reference/addworkspaceteammate.md): Add a new teammate to workspace or update existing teammate's role. **Blocked by:** Workspace revoked. - [Remove Teammate from Workspace](https://developers.rebrandly.com/reference/removeworkspaceteammate.md): Remove a teammate from the workspace. **Blocked by:** Workspace revoked. - [List Account Invites](https://developers.rebrandly.com/reference/listaccountinvites.md): List all invites sent from the account. - [Create Account Invite](https://developers.rebrandly.com/reference/createaccountinvite.md): Create a new invite to add a teammate. **Requires:** `collaboration.teammates` feature flag. - [Count Account Invites](https://developers.rebrandly.com/reference/countaccountinvites.md): Count invites by status. - [Get Account Invite](https://developers.rebrandly.com/reference/getaccountinvite.md): Get details of a specific invite. - [Delete Account Invite](https://developers.rebrandly.com/reference/deleteaccountinvite.md): Delete an invite. - [Send Invite Email](https://developers.rebrandly.com/reference/sendinviteemail.md): Re-send the invite email to the invitee. **Requires:** Internal API or invites scope. - [List Invite Workspaces](https://developers.rebrandly.com/reference/listinviteworkspaces.md): List workspaces the invite will grant access to. - [Count Invite Workspaces](https://developers.rebrandly.com/reference/countinviteworkspaces.md): Count workspaces the invite will grant access to. - [Create Account Invite](https://developers.rebrandly.com/reference/createaccountinviteexternal.md): Create invites to add teammates to the account and optionally to workspaces. - [Search](https://developers.rebrandly.com/reference/search-1.md): Search links and domains in the workspace. - [Count Search Results](https://developers.rebrandly.com/reference/countsearchresults.md): Get the count of links and domains matching a search term in the workspace. **Requires:** Authenticated user with workspace access. - [List Plans](https://developers.rebrandly.com/reference/listplans.md): List available subscription plans. **Note:** This endpoint does not require authentication. - [Get Plan](https://developers.rebrandly.com/reference/getplan.md): Get plan details. - [Count Plans](https://developers.rebrandly.com/reference/countplans.md): Get the total number of available subscription plans. **Note:** This endpoint does not require authentication. - [Get Plan Features](https://developers.rebrandly.com/reference/getplanfeatures.md): Get the resolved feature set for a plan: standard features merged with any plan-specific overrides. **Note:** This endpoint does not require authentication. - [List Features](https://developers.rebrandly.com/reference/listfeatures.md): Get all available features. **Note:** This endpoint does not require authentication. - [List Account Features](https://developers.rebrandly.com/reference/listaccountfeatures.md): Get all features available to the account (profile features, standard features, and addon features). - [List Report Templates](https://developers.rebrandly.com/reference/listreporttemplates.md): List all report templates in the workspace. **Requires:** - Workspace access - [Create Report Template](https://developers.rebrandly.com/reference/createreporttemplate.md): Create a new report template for scheduled or ad-hoc reports. **Requires:** - Feature: `reports.custom` **Blocked by:** Revoked workspace or domain. - [Count Report Templates](https://developers.rebrandly.com/reference/countreporttemplates.md): Get count of report templates in the workspace. **Requires:** - Workspace access - [Get Report Template](https://developers.rebrandly.com/reference/getreporttemplate.md): Get details of a specific report template. **Requires:** - Workspace access - [Update Report Template](https://developers.rebrandly.com/reference/updatereporttemplate.md): Update a report template. **Requires:** - Feature: `reports.custom` **Blocked by:** Revoked workspace. - [Delete Report Template](https://developers.rebrandly.com/reference/deletereporttemplate.md): Delete a report template and deactivate its schedule. **Requires:** - [List Report Results](https://developers.rebrandly.com/reference/listreportresults.md): List all report execution results in the workspace. - [List Template Executions](https://developers.rebrandly.com/reference/listtemplateexecutions.md): List all executions for a report template. - [Count Template Executions](https://developers.rebrandly.com/reference/counttemplateexecutions.md) - [Get Template Schedule](https://developers.rebrandly.com/reference/gettemplateschedule.md): Get the schedule configuration for a report template. - [Create or Update Schedule](https://developers.rebrandly.com/reference/upserttemplateschedule.md): Create or update the schedule for a report template. **Feature Required:** `reports.custom` - [Pause Schedule](https://developers.rebrandly.com/reference/pausetemplateschedule.md): Pause a report schedule. - [Resume Schedule](https://developers.rebrandly.com/reference/resumetemplateschedule.md): Resume a paused report schedule. **Feature Required:** `reports.custom` - [Trigger Scheduled Execution](https://developers.rebrandly.com/reference/triggertemplateschedule.md): Manually trigger a scheduled report execution. **Feature Required:** `reports.custom` - [List Apps](https://developers.rebrandly.com/reference/listapps.md): List all OAuth/mobile apps in the workspace. **Feature Required:** `links.apps` - [Create App](https://developers.rebrandly.com/reference/createapp.md): Create a new OAuth/mobile app. **Feature Required:** `links.apps` - [Count Apps](https://developers.rebrandly.com/reference/countapps.md) - [Get App](https://developers.rebrandly.com/reference/getapp.md) - [Update App](https://developers.rebrandly.com/reference/updateapp.md) - [Delete App](https://developers.rebrandly.com/reference/deleteapp.md) - [List App Links](https://developers.rebrandly.com/reference/listapplinks.md): Get links created via this app. - [List Addons](https://developers.rebrandly.com/reference/listaddons.md): Get available subscription addons. - [Get Addon](https://developers.rebrandly.com/reference/getaddon.md) - [Get Revoked Items](https://developers.rebrandly.com/reference/getrevokedentitlements.md): List revoked workspaces, domains, and features. - [Count Revoked Items](https://developers.rebrandly.com/reference/countrevokedentitlements.md) - [List Custom Attributes](https://developers.rebrandly.com/reference/listcustomattributes.md) - [Create Custom Attribute](https://developers.rebrandly.com/reference/createcustomattribute.md) - [Count Custom Attributes](https://developers.rebrandly.com/reference/countcustomattributes.md) - [Get Custom Attribute](https://developers.rebrandly.com/reference/getcustomattribute.md) - [Delete Custom Attribute](https://developers.rebrandly.com/reference/deletecustomattribute.md) - [Get Account Click Statistics](https://developers.rebrandly.com/reference/getaccountclicks.md): Get aggregated click statistics for the account. **Requires:** `metrics.advanced` feature flag. - [Get Account Segment Statistics](https://developers.rebrandly.com/reference/getaccountsegments.md): Alias for /account/clicks - get aggregated click statistics for the account. **Requires:** `metrics.advanced` feature flag. - [Get Workspace Click Statistics](https://developers.rebrandly.com/reference/getworkspaceclicks.md): Get click statistics for a workspace. **Requires:** `metrics.advanced` feature flag (owner must have it). - [Get Workspace Segment Statistics](https://developers.rebrandly.com/reference/getworkspacesegments.md): Alias for /workspaces/{workspace_id}/clicks. - [Get Tag Click Statistics](https://developers.rebrandly.com/reference/gettagclicks.md): Get click statistics for a tag. **Requires:** `metrics.advanced` feature flag. - [Get Tag Segment Statistics](https://developers.rebrandly.com/reference/gettagsegments.md): Alias for /tags/{tag_id}/clicks. - [Get Teammate Click Statistics](https://developers.rebrandly.com/reference/getteammateclicks.md): Get click statistics for a teammate in a workspace. **Requires:** `metrics.advanced` feature flag. - [Get Teammate Segment Statistics](https://developers.rebrandly.com/reference/getteammatesegments.md): Alias for teammate clicks endpoint. - [/v1/links](https://developers.rebrandly.com/reference/createlink-1.md): Create a new link - [/v1/links](https://developers.rebrandly.com/reference/getlinks-1.md): Get a list of links - [/v1/links](https://developers.rebrandly.com/reference/deletelinks-1.md): Delete multiple links in bulk - [/v1/links/:id](https://developers.rebrandly.com/reference/getlink-1.md): Get details about a specific link (don't know the ID? Fetch it using GET /v1/links) - [/v1/links/:id](https://developers.rebrandly.com/reference/update-link-endpoint-1.md): Update a specific link (don't know the ID? Fetch it using GET /v1/links). Mind that in a Link entity you cannot change the domain and/or the slashtag after creation time. You will need to create another Link. - [/v1/links/:id](https://developers.rebrandly.com/reference/delete-link-endpoint-1.md): Delete a specific link (don't know the ID? Fetch it using GET /v1/links) - [/v1/links/count](https://developers.rebrandly.com/reference/countlinks-1.md): Get how many links with given filtering conditions - [/v1/links/new](https://developers.rebrandly.com/reference/createexpresslink-1.md): Create a new link - [/v1/links/:id/tags](https://developers.rebrandly.com/reference/getlinktags-1.md): Get all tags attached to a specific link - [/v1/links/:id/tags/:tag](https://developers.rebrandly.com/reference/attachtag-1.md): Attach a tag to a link - [/v1/links/:id/tags/:tag](https://developers.rebrandly.com/reference/detachtag-1.md): Detach a tag from a link - [/v1/links/:id/scripts](https://developers.rebrandly.com/reference/getlinkscripts-1.md): Get all scripts attached to a specific link - [/v1/links/:id/scripts/:script](https://developers.rebrandly.com/reference/attachscript-1.md): Attach a retargeting script to a link - [/v1/links/:id/scripts/:script](https://developers.rebrandly.com/reference/detachscript-1.md): Detach a script from a link - [/v1/domains](https://developers.rebrandly.com/reference/getshareddomains-1.md): Get the list of domains shared in the current workspace. - [/v1/domains/:id](https://developers.rebrandly.com/reference/getshareddomain-1.md): Get details about a specific domain shared in the workspace - [/v1/domains/count](https://developers.rebrandly.com/reference/countshareddomains-1.md): Get how many domains with given filtering conditions - [/v1/tags/:id](https://developers.rebrandly.com/reference/deletetag-1.md): Delete a specific tag - [/v1/tags/:id](https://developers.rebrandly.com/reference/tag-details-endpoint-1.md): Get details about a specific tag - [/v1/tags/:id](https://developers.rebrandly.com/reference/update-tag-endpoint-1.md): Update a tag - [/v1/tags](https://developers.rebrandly.com/reference/gettags-1.md): Get a list of tags - [/v1/tags](https://developers.rebrandly.com/reference/create-tag-endpoint-1.md): Create a new tag - [/v1/tags/count](https://developers.rebrandly.com/reference/counttags-1.md): Get how many tags with given filtering conditions - [/v1/account](https://developers.rebrandly.com/reference/getaccount-1.md): Get account details - [List Workspaces](https://developers.rebrandly.com/reference/getsharedworkspaces-1.md): Get all workspaces you either own or participate into as a member - [/v1/scripts](https://developers.rebrandly.com/reference/getscripts-1.md): Get a list of scripts - [/v1/scripts](https://developers.rebrandly.com/reference/create-script-endpoint-1.md): Create a new script - [/v1/scripts/:id](https://developers.rebrandly.com/reference/getscript-1.md): Get details about a specific script - [/v1/scripts/:id](https://developers.rebrandly.com/reference/delete-script-endpoint-1.md): Delete a specific script - [/v1/scripts/:id](https://developers.rebrandly.com/reference/update-script-endpoint-1.md): Update a script - [/v1/scripts/count](https://developers.rebrandly.com/reference/countscripts-1.md): Get how many scripts with given filtering conditions ## Recipes - [Delete all links for a given domain](https://developers.rebrandly.com/recipes/delete-all-links-for-a-given-domain.md) - [Delete old/stale links](https://developers.rebrandly.com/recipes/delete-oldstale-links.md) - [Export links to CSV](https://developers.rebrandly.com/recipes/export-links-to-csv.md) - [Migrate links into another workspace](https://developers.rebrandly.com/recipes/migrate-links-into-another-workspace.md) - [No two links with the same destination](https://developers.rebrandly.com/recipes/no-two-links-with-the-same-destination.md) ## Pages - [Python SDK Documentation](https://developers.rebrandly.com/sdk-documentation.md)