> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Rebrandly

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

![Rebrandly logo](https://mintcdn.com/composio-preview/HvfZXDijhFOaKyF5/images/toolkits/rebrandly.svg?fit=max\&auto=format\&n=HvfZXDijhFOaKyF5\&q=85\&s=385014ecf1b66adf70cac8f619792fbf)

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

## Tools

> [accordion] 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
>
> **title** `string`
>
> Human-readable link title, up to 255 characters.
>
> **slashtag** `string`
>
> Custom URL path using letters, digits, underscore, or hyphen; omit to generate one.
>
> **domain\_id** `string`
>
> Verified domain public ID shared with the workspace; omit to use the provider default.
>
> **description** `string`
>
> Optional link notes; requires the links.notes feature.
>
> **workspace\_id** `string` *required*
>
> Workspace public ID in which to create the short link.
>
> **destination\_url** `string` *required*
>
> Absolute URL the short link will redirect to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> Tag display name.
>
> **color** `string` *required*
>
> Exactly six hexadecimal color characters without a leading #, for example 4F46E5.
>
> **workspace\_id** `string`
>
> Workspace public ID. Omit to use the connected account's default workspace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **link\_id** `string` *required*
>
> Public ID of the short link to stop and delete.
>
> **workspace\_id** `string`
>
> Workspace public ID. Omit to use the default workspace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Tag
>
> **Slug:** `REBRANDLY_DELETE_TAG`
>
> Delete a Rebrandly tag and remove that tag assignment from every associated link.
>
> #### Input Parameters
>
> **tag\_id** `string` *required*
>
> Public ID of the tag to delete from the workspace.
>
> **workspace\_id** `string`
>
> Workspace public ID. Omit to use the connected account's default workspace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account
>
> **Slug:** `REBRANDLY_GET_ACCOUNT`
>
> Return the connected Rebrandly account identity, current plan category, and account-specific usage limits.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **tag\_id** `string`
>
> Tag public ID. Required only for tag analytics.
>
> **group\_by** `string ("hours" | "days" | "months")`
>
> Time interval used to group click totals.
>
> **domain\_id** `string`
>
> 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")`
>
> Resource whose clicks should be aggregated.
>
> **teammate\_id** `string`
>
> Teammate account ID. Required only for teammate analytics.
>
> **workspace\_id** `string`
>
> Workspace public ID. Required for workspace and teammate analytics; optional for selecting the workspace containing a tag.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **domain\_id** `string` *required*
>
> 32-character domain public ID. Use LIST\_DOMAINS for workspace scope or LIST\_ACCOUNT\_DOMAINS for account scope.
>
> **domain\_scope** `string ("workspace" | "account")`
>
> 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`
>
> Workspace public ID for workspace scope. Omit to use the default workspace, and always omit for account scope.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Link
>
> **Slug:** `REBRANDLY_GET_LINK`
>
> Return complete details for one Rebrandly short link by its public ID.
>
> #### Input Parameters
>
> **link\_id** `string` *required*
>
> Public ID of the short link.
>
> **workspace\_id** `string`
>
> Workspace public ID. Omit to use the default workspace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Tag
>
> **Slug:** `REBRANDLY_GET_TAG`
>
> Return one tag by its public ID from the default or selected Rebrandly workspace.
>
> #### Input Parameters
>
> **tag\_id** `string` *required*
>
> Public ID of the tag.
>
> **workspace\_id** `string`
>
> Workspace public ID. Omit to use the connected account's default workspace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workspace
>
> **Slug:** `REBRANDLY_GET_WORKSPACE`
>
> Return details, resource statistics, role, and plan context for one accessible Rebrandly workspace by public ID.
>
> #### Input Parameters
>
> **workspace\_id** `string` *required*
>
> Public ID from LIST\_WORKSPACES for an owned workspace or LIST\_ACCESSIBLE\_WORKSPACES for a shared workspace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum accessible workspaces in this page (1-25).
>
> **offset** `integer`
>
> Zero-based result offset. Use next\_offset from the preceding response.
>
> **order\_by** `string ("name" | "createdAt")`
>
> Sort field: name or createdAt.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call.
>
> **order\_direction** `string ("asc" | "desc")`
>
> Sort direction: asc or desc.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum account-owned domains in this page (1-25).
>
> **active** `boolean`
>
> Filter account-owned domains by active status.
>
> **order\_by** `string`
>
> Provider field used to sort domains.
>
> **domain\_type** `string ("USER" | "SERVICE")`
>
> Filter account-owned domains by provider type: USER or SERVICE.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **order\_direction** `string ("asc" | "desc")`
>
> Sort direction.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum domains in this page (1-25).
>
> **active** `boolean`
>
> Filter domains by active status.
>
> **order\_by** `string`
>
> Provider field used to sort domains.
>
> **verified** `boolean`
>
> Filter domains by DNS verification status.
>
> **domain\_type** `string ("user" | "service")`
>
> Return only user-owned or service domains.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **workspace\_id** `string`
>
> Workspace public ID. Omit to use the connected account's default workspace.
>
> **order\_direction** `string ("asc" | "desc")`
>
> Sort direction.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **scope** `string ("account" | "workspace")`
>
> Feature entitlement scope to inspect.
>
> **revoked** `boolean`
>
> When true, return revoked features instead of enabled features.
>
> **workspace\_id** `string`
>
> Workspace public ID; required when scope is workspace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum links in this page (1-25).
>
> **active** `boolean`
>
> Filter by active redirect status.
>
> **order\_by** `string`
>
> Provider field used to sort links.
>
> **slashtag** `string`
>
> Return links with this exact URL path component.
>
> **domain\_id** `string`
>
> Return links using this domain public ID.
>
> **favourite** `boolean`
>
> Filter by favourite status.
>
> **creator\_id** `string`
>
> Return links created by this account ID.
>
> **domain\_name** `string`
>
> Return links using this exact domain name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call. Do not edit it.
>
> **workspace\_id** `string`
>
> Workspace public ID. Omit to use the default workspace.
>
> **order\_direction** `string ("asc" | "desc")`
>
> Sort direction.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **term** `string`
>
> Filter tags by name search term.
>
> **limit** `integer`
>
> Maximum tags in this page (1-25).
>
> **order\_by** `string`
>
> Provider field used to sort tags.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **workspace\_id** `string`
>
> Workspace public ID. Omit to use the connected account's default workspace.
>
> **order\_direction** `string ("asc" | "desc")`
>
> Sort direction.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **term** `string`
>
> Filter workspaces by name search term.
>
> **limit** `integer`
>
> Maximum workspaces to return in this page (1-25).
>
> **revoked** `boolean`
>
> Filter by revoked status; omit to include active and revoked workspaces.
>
> **order\_by** `string`
>
> Provider workspace field used to sort results.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **workspace\_type** `string ("classic" | "extended" | "gallery")`
>
> Return only classic, extended, or gallery workspaces.
>
> **order\_direction** `string ("asc" | "desc")`
>
> Sort results in ascending or descending order.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **term** `string`
>
> Text matched against destination URLs, slashtags, and titles.
>
> **limit** `integer`
>
> Maximum matching links in this page (1-25).
>
> **tag\_id** `string`
>
> Restrict results to links assigned this tag public ID.
>
> **domain\_id** `string`
>
> Restrict results to this domain public ID.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call. It restores the original search filters and workspace.
>
> **workspace\_id** `string`
>
> Workspace public ID. Omit to search the connected account's default workspace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **tag\_id** `string` *required*
>
> Public ID of the tag.
>
> **link\_id** `string` *required*
>
> Public ID of the short link.
>
> **assigned** `boolean` *required*
>
> Set true to assign the tag or false to remove its assignment.
>
> **workspace\_id** `string`
>
> Workspace public ID. Omit to use the default workspace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **title** `string`
>
> New human-readable link title.
>
> **link\_id** `string` *required*
>
> Public ID of the short link to update.
>
> **favourite** `boolean`
>
> Set whether the link is marked as a favourite.
>
> **description** `string`
>
> New link notes; requires the links.notes feature.
>
> **workspace\_id** `string`
>
> Workspace public ID. Omit to use the default workspace.
>
> **destination\_url** `string`
>
> New absolute redirect destination.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string`
>
> New tag display name.
>
> **color** `string`
>
> New six-character hexadecimal color without a leading #.
>
> **tag\_id** `string` *required*
>
> Public ID of the tag to update.
>
> **workspace\_id** `string`
>
> Workspace public ID. Omit to use the connected account's default workspace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
