---
canonical_url: "https://docs.composio.dev/toolkits/rebrandly"
markdown_url: "https://docs.composio.dev/toolkits/rebrandly.md"
product: "platform"
version: null
last_updated: null
---

# Rebrandly

Rebrandly is a link management platform for creating branded short links, managing domains and workspaces, and analyzing link performance.

- **Category:** url shortener
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 22
- **Triggers:** 0
- **Slug:** `REBRANDLY`
- **Version:** 00000000_00

## Tools

### Create Link

**Slug:** `REBRANDLY_CREATE_LINK`

Create one classic Rebrandly short link in a selected workspace. This consumes the account's link allowance even if the link is later deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Human-readable link title, up to 255 characters. |
| `slashtag` | string | No | Custom URL path using letters, digits, underscore, or hyphen; omit to generate one. |
| `domain_id` | string | No | Verified domain public ID shared with the workspace; omit to use the provider default. |
| `description` | string | No | Optional link notes; requires the links.notes feature. |
| `workspace_id` | string | Yes | Workspace public ID in which to create the short link. |
| `destination_url` | string | Yes | Absolute URL the short link will redirect to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tag

**Slug:** `REBRANDLY_CREATE_TAG`

Create a tag for categorizing links in the default or selected Rebrandly workspace. Requires the links.tags feature.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Tag display name. |
| `color` | string | Yes | Exactly six hexadecimal color characters without a leading #, for example 4F46E5. |
| `workspace_id` | string | No | Workspace public ID. Omit to use the connected account's default workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Link

**Slug:** `REBRANDLY_DELETE_LINK`

Soft-delete a short link so it no longer redirects. Deleting it may not restore the account's link allowance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link_id` | string | Yes | Public ID of the short link to stop and delete. |
| `workspace_id` | string | No | Workspace public ID. Omit to use the default workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tag

**Slug:** `REBRANDLY_DELETE_TAG`

Delete a Rebrandly tag and remove that tag assignment from every associated link.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | Public ID of the tag to delete from the workspace. |
| `workspace_id` | string | No | Workspace public ID. Omit to use the connected account's default workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account

**Slug:** `REBRANDLY_GET_ACCOUNT`

Return the connected Rebrandly account identity, current plan category, and account-specific usage limits.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Click Analytics

**Slug:** `REBRANDLY_GET_CLICK_ANALYTICS`

Return time-grouped click analytics for the connected account, a workspace, account-owned domain, tag, or workspace teammate. Every analytics route requires the metrics.advanced feature. Domain analytics does not accept workspace-shared SYSTEM domain IDs returned by the workspace domains collection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | No | Tag public ID. Required only for tag analytics. |
| `group_by` | string ("hours" | "days" | "months") | No | Time interval used to group click totals. |
| `domain_id` | string | No | Account-owned domain public ID from Rebrandly's account domains collection. Required only for domain analytics; workspace-shared SYSTEM domains such as rebrand.ly are not valid for this route. |
| `entity_type` | string ("account" | "workspace" | "domain" | "tag" | "teammate") | No | Resource whose clicks should be aggregated. |
| `teammate_id` | string | No | Teammate account ID. Required only for teammate analytics. |
| `workspace_id` | string | No | Workspace public ID. Required for workspace and teammate analytics; optional for selecting the workspace containing a tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Domain

**Slug:** `REBRANDLY_GET_DOMAIN`

Return details for one Rebrandly domain by public ID. Use workspace scope for a domain shared with the default or selected workspace, or account scope for a domain owned by the connected account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain_id` | string | Yes | 32-character domain public ID. Use LIST_DOMAINS for workspace scope or LIST_ACCOUNT_DOMAINS for account scope. |
| `domain_scope` | string ("workspace" | "account") | No | Use workspace for a domain shared with the default or selected workspace, or account for a domain owned by the connected account. |
| `workspace_id` | string | No | Workspace public ID for workspace scope. Omit to use the default workspace, and always omit for account scope. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Link

**Slug:** `REBRANDLY_GET_LINK`

Return complete details for one Rebrandly short link by its public ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link_id` | string | Yes | Public ID of the short link. |
| `workspace_id` | string | No | Workspace public ID. Omit to use the default workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tag

**Slug:** `REBRANDLY_GET_TAG`

Return one tag by its public ID from the default or selected Rebrandly workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | Public ID of the tag. |
| `workspace_id` | string | No | Workspace public ID. Omit to use the connected account's default workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace

**Slug:** `REBRANDLY_GET_WORKSPACE`

Return details, resource statistics, role, and plan context for one accessible Rebrandly workspace by public ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Public ID from LIST_WORKSPACES for an owned workspace or LIST_ACCESSIBLE_WORKSPACES for a shared workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Accessible Workspaces

**Slug:** `REBRANDLY_LIST_ACCESSIBLE_WORKSPACES`

List workspaces the connected Rebrandly user can access, including shared workspaces not owned by the account. Pass next_cursor unchanged to request another page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum accessible workspaces in this page (1-25). |
| `offset` | integer | No | Zero-based result offset. Use next_offset from the preceding response. |
| `order_by` | string ("name" | "createdAt") | No | Sort field: name or createdAt. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. |
| `order_direction` | string ("asc" | "desc") | No | Sort direction: asc or desc. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Account Domains

**Slug:** `REBRANDLY_LIST_ACCOUNT_DOMAINS`

List one cursor-paginated page of domains owned by the connected Rebrandly account, distinct from domains merely shared with a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum account-owned domains in this page (1-25). |
| `active` | boolean | No | Filter account-owned domains by active status. |
| `order_by` | string | No | Provider field used to sort domains. |
| `domain_type` | string ("USER" | "SERVICE") | No | Filter account-owned domains by provider type: USER or SERVICE. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `order_direction` | string ("asc" | "desc") | No | Sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Domains

**Slug:** `REBRANDLY_LIST_DOMAINS`

List one cursor-paginated page of domains available to the default or selected Rebrandly workspace, with active and verification filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum domains in this page (1-25). |
| `active` | boolean | No | Filter domains by active status. |
| `order_by` | string | No | Provider field used to sort domains. |
| `verified` | boolean | No | Filter domains by DNS verification status. |
| `domain_type` | string ("user" | "service") | No | Return only user-owned or service domains. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `workspace_id` | string | No | Workspace public ID. Omit to use the connected account's default workspace. |
| `order_direction` | string ("asc" | "desc") | No | Sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Enabled Features

**Slug:** `REBRANDLY_LIST_ENABLED_FEATURES`

List enabled or revoked Rebrandly features for the account or a workspace owner before calling feature-gated tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("account" | "workspace") | No | Feature entitlement scope to inspect. |
| `revoked` | boolean | No | When true, return revoked features instead of enabled features. |
| `workspace_id` | string | No | Workspace public ID; required when scope is workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Links

**Slug:** `REBRANDLY_LIST_LINKS`

List one cursor-paginated page of short links in the default or selected workspace, with exact domain, slashtag, creator, favourite, and active-status filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum links in this page (1-25). |
| `active` | boolean | No | Filter by active redirect status. |
| `order_by` | string | No | Provider field used to sort links. |
| `slashtag` | string | No | Return links with this exact URL path component. |
| `domain_id` | string | No | Return links using this domain public ID. |
| `favourite` | boolean | No | Filter by favourite status. |
| `creator_id` | string | No | Return links created by this account ID. |
| `domain_name` | string | No | Return links using this exact domain name. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. Do not edit it. |
| `workspace_id` | string | No | Workspace public ID. Omit to use the default workspace. |
| `order_direction` | string ("asc" | "desc") | No | Sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Revoked Entitlements

**Slug:** `REBRANDLY_LIST_REVOKED_ENTITLEMENTS`

List revoked Rebrandly workspaces, domains, and feature entitlements so an agent can diagnose why a formerly available resource or capability is inaccessible.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tags

**Slug:** `REBRANDLY_LIST_TAGS`

List or search one page of tags in the default or selected Rebrandly workspace so an agent can resolve tag IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `term` | string | No | Filter tags by name search term. |
| `limit` | integer | No | Maximum tags in this page (1-25). |
| `order_by` | string | No | Provider field used to sort tags. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `workspace_id` | string | No | Workspace public ID. Omit to use the connected account's default workspace. |
| `order_direction` | string ("asc" | "desc") | No | Sort direction. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspaces

**Slug:** `REBRANDLY_LIST_WORKSPACES`

List one page of workspaces owned by the connected Rebrandly account so an agent can resolve workspace IDs, roles, and resource counts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `term` | string | No | Filter workspaces by name search term. |
| `limit` | integer | No | Maximum workspaces to return in this page (1-25). |
| `revoked` | boolean | No | Filter by revoked status; omit to include active and revoked workspaces. |
| `order_by` | string | No | Provider workspace field used to sort results. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `workspace_type` | string ("classic" | "extended" | "gallery") | No | Return only classic, extended, or gallery workspaces. |
| `order_direction` | string ("asc" | "desc") | No | Sort results in ascending or descending order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Links

**Slug:** `REBRANDLY_SEARCH_LINKS`

Search short links by destination, slashtag, or title, optionally narrowed to a domain. Alternatively, list links assigned to one tag. Tag filtering cannot be combined with term or domain filters. Returns one cursor-controlled page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `term` | string | No | Text matched against destination URLs, slashtags, and titles. |
| `limit` | integer | No | Maximum matching links in this page (1-25). |
| `tag_id` | string | No | Restrict results to links assigned this tag public ID. |
| `domain_id` | string | No | Restrict results to this domain public ID. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. It restores the original search filters and workspace. |
| `workspace_id` | string | No | Workspace public ID. Omit to search the connected account's default workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Link Tag Assignment

**Slug:** `REBRANDLY_SET_LINK_TAG_ASSIGNMENT`

Ensure a tag is assigned to or removed from one Rebrandly short link according to the requested state. Requires the links.tags feature and a classic or gallery workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | Public ID of the tag. |
| `link_id` | string | Yes | Public ID of the short link. |
| `assigned` | boolean | Yes | Set true to assign the tag or false to remove its assignment. |
| `workspace_id` | string | No | Workspace public ID. Omit to use the default workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Link

**Slug:** `REBRANDLY_UPDATE_LINK`

Update a short link's destination, title, notes, or favourite status without changing its link type. Unchanged destination, title, and notes values are preserved automatically.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | New human-readable link title. |
| `link_id` | string | Yes | Public ID of the short link to update. |
| `favourite` | boolean | No | Set whether the link is marked as a favourite. |
| `description` | string | No | New link notes; requires the links.notes feature. |
| `workspace_id` | string | No | Workspace public ID. Omit to use the default workspace. |
| `destination_url` | string | No | New absolute redirect destination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tag

**Slug:** `REBRANDLY_UPDATE_TAG`

Update at least one of a tag's name or color in the default or selected Rebrandly workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New tag display name. |
| `color` | string | No | New six-character hexadecimal color without a leading #. |
| `tag_id` | string | Yes | Public ID of the tag to update. |
| `workspace_id` | string | No | Workspace public ID. Omit to use the connected account's default workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |