Skip to main content
Shorten.REST logo
  • Category: url shortener
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 6
  • Triggers: 0
  • Slug: SHORTEN_REST
  • Version: 20260615_00

Tools

Slug: SHORTEN_REST_CREATE_ALIASTool to create a new alias (short URL) under a specified domain. Use when you need to shorten a URL. If no domain is specified, the alias will be attached to the default domain Short.fyi. You can override domain-level Meta Tags and Tracking Snippets by specifying them for each URL.

Input Parameters

array
List of metatags for the alias. Use to override domain-level meta tags
array
List of tracking snippets for the alias. Use to override domain-level tracking snippets
string
Alias name (without / at the beginning). If not specified, a random alias will be generated
string
Domain which alias will belong to (string without http/https or /). If not specified, defaults to ‘short.fyi’
array
required
List of destination URLs with optional geo-targeting. At least one destination is required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTEN_REST_DELETE_ALIASTool to delete a single alias by providing alias and domain. Use when you need to remove an existing shortened URL. If no domain is provided, the API searches for the matching alias within the Short.fyi domain.

Input Parameters

string
required
Alias to delete (without / at the beginning). This is the short code identifier for the URL.
string
Domain which alias belongs to (string without http/https or /). If not provided, defaults to short.fyi.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTEN_REST_GET_ALIASESTool to retrieve all URL aliases of the authenticated user. Use when you need to list existing aliases (supports pagination).

Input Parameters

integer
Maximum number of aliases to return per page (must be ≥ 1)
string
Cursor token for pagination to fetch the next set of aliases

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTEN_REST_GET_CLICKSTool to retrieve click data for shortened URLs. Use to check click analytics for your aliases. Returns a list of click records which may be empty if no clicks have occurred yet. Returned records may represent a limited window or subset of historical clicks rather than complete per-click logs.

Input Parameters

string
The alias (short code) to retrieve click information for. If not provided, returns clicks for all aliases.
integer
Maximum number of click records to return (must be >= 1)
string
Cursor token for pagination to fetch the next set of clicks

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTEN_REST_LIST_ALIASES_BY_DOMAINTool to retrieve all alias names associated with your account and a given domain. Results are in descending order by creation date. Use when you need to list alias names (not full details) for a specific domain with pagination support.

Input Parameters

integer
Number of results to return per request (must be >= 1). Defaults to 1000 if not specified.
string
The domain name to get the aliases for (string without http/https or /). If not provided, defaults to ‘short.fyi’.
string
An ID returned by a previous query to continue aliases retrieval (see last_id in response). Used for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORTEN_REST_UPDATE_ALIASTool to update an existing short URL alias by providing its alias name and domain. Use when you need to modify destinations, metatags, or snippets for an existing alias. IMPORTANT: When updating array properties (like destinations), the entire array is replaced, so you must include all existing records you want to keep.

Input Parameters

array
List of metatags to update. IMPORTANT: When updating array properties, the entire block is replaced, so include all old records you want to keep.
array
List of snippets to update. IMPORTANT: When updating array properties, the entire block is replaced, so include all old records you want to keep.
string
required
The alias name to update (without leading slash, e.g., ‘aBcDe012’)
string
Domain which the alias belongs to (without http/https or trailing slash). Defaults to ‘short.fyi’.
array
List of destination URLs to update. IMPORTANT: When updating array properties, the entire block is replaced, so include all old records you want to keep to avoid deleting them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not