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

# lc.cx

lc.cx provides URL shortening, branded domains, workspaces, tags, click statistics, and QR code generation through its API.

- **Category:** url shortener
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `LC_CX`
- **Version:** 00000000_00

## Tools

### Create Short Link

**Slug:** `LC_CX_CREATE_SHORT_LINK`

Shorten one destination URL on lc.cx, optionally choosing its path, tags, note, and workspace. Warning: each successful creation permanently consumes one unit of the current monthly quota, even if the link is later deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | No | Private note of at most 255 characters. |
| `tag_ids` | array | No | Existing tag ids to attach to the short link. |
| `domain_id` | string | No | Domain id from Get Account Context. Defaults to the built-in lc.cx domain. |
| `custom_path` | string | No | Requested URL path without a leading slash. Omit for an automatically generated path. |
| `destination` | string | Yes | Absolute HTTP or HTTPS destination URL for the short link. |
| `workspace_id` | string | No | Workspace in which to create the link. Omit to use the personal/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 |

### Create Tags

**Slug:** `LC_CX_CREATE_TAGS`

Create one or more tags in a workspace and return their ids for attaching to short links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | One or more tags to create. |
| `workspace_id` | string | No | Workspace in which to create the tags. Omit to use the personal/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 Short Link

**Slug:** `LC_CX_DELETE_SHORT_LINK`

Permanently delete one short link. Deletion does not restore the monthly creation quota.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link_id` | string | Yes | Short-link id to permanently delete. |
| `workspace_id` | string | No | Workspace containing the link. Omit to use the personal/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:** `LC_CX_DELETE_TAG`

Permanently delete one tag from the selected workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | Tag id to permanently delete. |
| `workspace_id` | string | No | Workspace containing the tag. Omit to use the personal/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 Context

**Slug:** `LC_CX_GET_ACCOUNT_CONTEXT`

Return lc.cx plan and short-link quota information together with available domains and workspaces needed to create and route short links.

#### 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 Short Link

**Slug:** `LC_CX_GET_SHORT_LINK`

Retrieve one short link by its lc.cx link id from the selected workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link_id` | string | Yes | Short-link id returned by create or list. |
| `workspace_id` | string | No | Workspace containing the link. Omit to use the personal/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 |

### List Short Links

**Slug:** `LC_CX_LIST_SHORT_LINKS`

Return one page of recently created short links in the selected workspace, with an offset for the next page when one may exist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `offset` | integer | No | Number of newer links to skip. Use next_offset from the prior response to continue. |
| `workspace_id` | string | No | Workspace to read from. Omit to use the personal/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 |

### List Tags

**Slug:** `LC_CX_LIST_TAGS`

Return all tags available in the selected workspace for organizing short links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | No | Workspace whose tags to list. Omit to use the personal/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 Short Link

**Slug:** `LC_CX_UPDATE_SHORT_LINK`

Update a short link's destination, note, or complete tag assignment. tag_ids is the full replacement list; resend current ids to preserve them or [] to clear.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | No | New private note. Send an empty string to clear it. |
| `link_id` | string | Yes | Short-link id to update. |
| `tag_ids` | array | Yes | Complete replacement tag-id list. Get the current link and resend its tag ids to preserve them, or send [] to remove all tags. |
| `destination` | string | No | New absolute destination URL. |
| `workspace_id` | string | No | Workspace containing the link. Omit to use the personal/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 Tag

**Slug:** `LC_CX_UPDATE_TAG`

Update the name or color of one tag in the selected workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New tag name. |
| `color` | string | No | New six-digit hexadecimal color including #. |
| `tag_id` | string | Yes | Tag id to update. |
| `workspace_id` | string | No | Workspace containing the tag. Omit to use the personal/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 |
