T

T.LY URL Shortener API Documentation

Create, update and track short links, QR codes and OneLinks with the T.LY API. Rate limits apply per user and are shared across that user's API tokens.…

Developer tools#url-shorteners

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Create, update and track short links, QR codes and OneLinks with the T.LY API.

Rate limits apply per user and are shared across that user's API tokens. Creating short links has its own counter. All other documented API endpoints, including listing links, share one general counter. Monthly link allowances apply to the team and are separate from rate limits.

For temporary throttling, honor Retry-After when present. For monthly allowance errors, stop retrying until the allowance changes. See API rate limits and retries for the current limits and response headers.

Endpoints 52

Account and Usage

  • GETGet the current user/api/v1/account/userReturns the name and email of the user associated with the API token.
  • GETList team members/api/v1/account/team-membersReturns members of the token's team, sorted by name. Use their id values in the user_ids filter on link lists and team analytics. The response contains names…
  • GETGet team usage/api/v1/account/usageReturns usage and plan allowances for the token's team in one request. Each resource has an integer used count and limit, including team-specific allowances.…

Domain Lookup

  • GETList domains/api/v1/domain/listReturns verified custom domains belonging to the token's team. Use the domain URL when creating links or filtering short-link lists and team analytics.…

OneLink Management

  • GETList OneLinks/api/v1/onelink/listReturns your team's OneLinks, 30 per page, most recently updated first. Use page to continue while current_page is less than last_page.
  • GETGet OneLink stats/api/v1/onelink/stats?short_url=https://t.ly/oneReturns OneLink page visits in clicks, unique_clicks and total_qr_scans, and button interactions in link_clicks. Summary counts use the selected date range;…

Pixel Management

  • GETList pixels/api/v1/link/pixelReturns all of your team's pixels.
  • POSTCreate a pixel/api/v1/link/pixelCreates a retargeting pixel you can add to links.
  • GETGet a pixel/api/v1/link/pixel/:idReturns one retargeting pixel.
  • PUTUpdate a pixel/api/v1/link/pixel/:idChanges a retargeting pixel.
  • DELETEDelete a pixel/api/v1/link/pixel/:idDeletes a retargeting pixel. Links that used it keep working.

QR Code Management

  • GETGet a QR code/api/v1/link/qr-code?short_url=https://t.ly/c55jReturns the QR code for a short link as a PNG image. Set output to base64 to get a base64 data URI in JSON instead.
  • PUTUpdate a QR code/api/v1/link/qr-codeReplaces a short link's QR styling: colors, dot and corner styles, and a logo in the middle. Omitted colors reset to the defaults below, omitted styles reset…

ShortLink Management

  • POSTCreate a short link/api/v1/link/shortenShortens a long URL. You can also set a custom ending, an expiry, a password, tags and pixels, and add Smart URLs or A/B rotation in the same call.
  • GETList short links/api/v1/link/listReturns your team's short links, newest first, 15 to a page unless you set limit. Send both start_date and end_date to filter by creation time; a single bound…
  • POSTExpand a short link/api/v1/link/expandReturns the long URL a short link points to. A successful expansion can record a visit, or a QR scan when is_qr_code is true, subject to analytics tracking…
  • POSTBulk shorten links/api/v1/link/bulkCreates up to 100,000 short links in the background. Send return_job: true to receive a job ID and progress URLs with HTTP 202. Poll the status URL every 3–5…
  • POSTBulk update links/api/v1/link/bulk/updateUpdates up to 100,000 links in the background. Leave a field out or blank to keep its current value. Send return_job: true to receive a job ID and progress…
  • GETGet a short link/api/v1/link?short_url=https://t.ly/c55jReturns one short link, with its tags, pixels and QR code.
  • PUTUpdate a short link/api/v1/linkUpdates a short link. Omitted expire_at_datetime and expire_at_views are cleared, and omitted public_stats becomes false. Send their current values to…
  • DELETEDelete a short link/api/v1/linkReturns HTTP 202 with an empty body. Deletion may take time to complete. The link may continue redirecting until then.
  • GETGet link stats/api/v1/link/stats?short_url=https://t.ly/c55jReturns visits, unique visits and QR scans for a short link. Summary counts use the selected date range; all_time ignores it. Unique counts add daily unique…
  • GETGet bulk job status/api/v1/link/bulk/:jobChecks a bulk create or update job for the token's team. Poll every 3–5 seconds while queued or processing. Stop at completed, completed_with_errors, or…
  • GETList failed bulk rows/api/v1/link/bulk/:job/failuresReturns failed rows from a bulk create or update job, ordered by their original position. row_number starts at 1 for the first item in the submitted links…

Tag Management

  • GETList tags/api/v1/link/tagReturns all of your team's tags.
  • POSTCreate a tag/api/v1/link/tagCreates a tag you can add to links.
  • GETGet a tag/api/v1/link/tag/:idReturns one tag.
  • PUTUpdate a tag/api/v1/link/tag/:idChanges a tag.
  • DELETEDelete a tag/api/v1/link/tag/:idDeletes a tag. Links that used it keep working.

Team Analytics

  • GETGet team visits/api/v1/team/stats/visitsReturns visit totals across matching links. Reports use the token's team and aggregate daily analytics. total includes QR visits; qr_total is the QR subset.…
  • GETGet daily team visits/api/v1/team/stats/daily-visitsReturns matching visits by day, oldest day first. Days without recorded visits are omitted. Reports use the token's team and aggregate daily analytics. total…
  • GETList top team links/api/v1/team/stats/top-short-linksReturns matching links ranked by visit count, highest first, with 10 links per page. Only links with recorded analytics in the range appear. Use page to…
  • GETGet team countries/api/v1/team/stats/countriesReturns visits grouped by countries. Row order is unspecified; sort in your client if needed. Reports use the token's team and aggregate daily analytics.…
  • GETGet team cities/api/v1/team/stats/citiesReturns visits grouped by cities. Row order is unspecified; sort in your client if needed. Reports use the token's team and aggregate daily analytics. total…
  • GETGet team referrers/api/v1/team/stats/referrersReturns visits grouped by referrers. Row order is unspecified; sort in your client if needed. Reports use the token's team and aggregate daily analytics.…
  • GETGet team platforms/api/v1/team/stats/platformsReturns visits grouped by platforms. Row order is unspecified; sort in your client if needed. Reports use the token's team and aggregate daily analytics.…
  • GETGet team browsers/api/v1/team/stats/browsersReturns visits grouped by browsers. Row order is unspecified; sort in your client if needed. Reports use the token's team and aggregate daily analytics. total…
  • GETGet team languages/api/v1/team/stats/languagesReturns visits grouped by languages. Row order is unspecified; sort in your client if needed. Reports use the token's team and aggregate daily analytics.…
  • GETList team visits/api/v1/team/clicksReturns individual visits and QR scans, newest first, for links still in the token's team. Use key as the row identifier. OneLink rows have a null…

UTM Preset Management

  • GETList UTM presets/api/v1/link/utm-presetReturns all of your team's UTM presets.
  • POSTCreate a UTM preset/api/v1/link/utm-presetCreates a UTM preset you can add to links. Include at least one non-empty UTM value.
  • GETGet a UTM preset/api/v1/link/utm-preset/:idReturns one UTM preset.
  • PUTUpdate a UTM preset/api/v1/link/utm-preset/:idChanges a UTM preset. Include at least one non-empty UTM value. Omitted UTM values are cleared.
  • DELETEDelete a UTM preset/api/v1/link/utm-preset/:idDeletes a UTM preset. Links that used it keep working.

Webhook Management

  • GETList webhooks/api/v1/webhookReturns all webhook subscriptions for your team. Secrets are omitted. An empty array means none are configured. Requires a Business plan with webhook access.…
  • POSTCreate a webhook/api/v1/webhookCreates an event subscription. Store the returned secret immediately; it is shown only on creation or rotation. Your receiver must accept JSON POST requests…
  • GETGet a webhook/api/v1/webhook/:idReturns one subscription. Its secret is omitted. Returns 404 when the webhook does not belong to the team. Requires a Business plan with webhook access. All…
  • PUTUpdate a webhook/api/v1/webhook/:idChanges only the supplied fields. Send tags: [] to remove tag filters. If events is supplied, it replaces the entire subscription list and must not be empty.…
  • DELETEDelete a webhook/api/v1/webhook/:idDeletes this subscription. Returns 202 with an empty body. Requires a Business plan with webhook access. All operations use the token's team. See the webhook…
  • POSTSend a test webhook/api/v1/webhook/:id/testRequests a test delivery for the first subscribed event and returns 202 with an empty body without waiting for delivery. Set sync=true to attempt delivery…
  • GETList webhook deliveries/api/v1/webhook/logsReturns delivery attempts, newest first, with success, failed or skipped status. Retries can create separate rows with different attempt values. Logs are…
  • POSTResend a webhook delivery/api/v1/webhook/logs/:id/resendResends the original event using the webhook's current settings. This sends a new delivery and can repeat a downstream action; use it deliberately. Returns…

API details

Base URL
https://api.t.ly
Authentication
A bearer token in the Authorization header
Operations
52 operations on 37 pathsGET 31POST 10PUT 6DELETE 5
Main resources
ShortLink Management 11Team Analytics 10Webhook Management 8Pixel Management 5Tag Management 5UTM Preset Management 5Account and Usage 3OneLink Management 2QR Code Management 2Domain Lookup 1
Response formats
application/json text/plain application/octet-stream image/png
Description format
OpenAPI 3.0.3, API version 1.0.0

How to test the T.LY URL Shortener API Documentation in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the T.LY URL Shortener API Documentation collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get the current user” (GET /api/v1/account/user), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the T.LY URL Shortener API Documentation?

Create, update and track short links, QR codes and OneLinks with the T.LY API. Rate limits apply per user and are shared across that user's API tokens.… It is listed under Developer tools and has 52 endpoints.

Who publishes the T.LY URL Shortener API Documentation?

It is listed from T's public API description (an OpenAPI document), not published by T on Swastik Codes. Anyone who controls t.ly can claim the profile by adding a DNS TXT record.

What is the base URL of the T.LY URL Shortener API Documentation?

Requests go to https://api.t.ly. Endpoint paths are added to this base URL.

How do I authenticate with the T.LY URL Shortener API Documentation?

With A bearer token in the Authorization header.

How many endpoints does the T.LY URL Shortener API Documentation have?

52 operations on 37 paths (31 GET, 10 POST, 6 PUT, 5 DELETE). The largest groups are ShortLink Management, Team Analytics, Webhook Management, Pixel Management.

Is forking the T.LY URL Shortener API Documentation free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.