Name

Get a short link

One of your links by domain and code.

HTTP method and path

GET/api/v6/urlshortener/links/{domain}/{code}

https://developers.hablame.co/api/v6/urlshortener/links/{domain}/{code}

What happens when you run it

Read only: it does not change your organization’s data.
The call is not charged.

What it does

Returns one link of your organization with its lifetime counters. A deleted one, or one from another organization, returns 404. One blocked by Hablame comes back with status: blocked.

Availability and prerequisites

Published and available in the production API v6.
Every path starts at https://developers.hablame.co.
You need a Hablame API key to call it.

Create your API key

Authentication and permissions

Send your API key in the Authorization header with the Bearer scheme.

Who can call it: An API key with the urlshortener service enabled.

Limits and operational notes

Usage limit: 60 requests per minute.

Path parameters

Name Type Description and rules

Name	Type	Description and rules
`domain`Required	`string`	Domain of the link, as the API returns it in `domain`. Compared in lowercase. It names the link that answers at that short URL today; for one on a domain that no longer belongs to your organization (`domainStatus: released`), add `domainStatus=released`. Example:`h0b.co`
`code`Required	`string`	Code or alias of the link. Compared in lowercase. Example:`a1b2c3d`

domainRequired

string

Domain of the link, as the API returns it in domain. Compared in lowercase. It names the link that answers at that short URL today; for one on a domain that no longer belongs to your organization (domainStatus: released), add domainStatus=released.

Example:h0b.co

codeRequired

string

Code or alias of the link. Compared in lowercase.

Example:a1b2c3d

Query parameters

Name Type Description and rules

Name	Type	Description and rules
`domainStatus`Optional	`string`	With `released`, the link is the one on a domain that no longer belongs to your organization (the one the list returns with `domainStatus: released`), even if that name is today another domain with the same code. Without it, `domain` names the domain that has that name today. Any other value returns `400 VALIDATION_INVALID_PARAMETER`. Allowed values:`released`

domainStatusOptional

string

With released, the link is the one on a domain that no longer belongs to your organization (the one the list returns with domainStatus: released), even if that name is today another domain with the same code. Without it, domain names the domain that has that name today. Any other value returns 400 VALIDATION_INVALID_PARAMETER.

Allowed values:released

HTTP headers

Name Type Description and rules

Name	Type	Description and rules
`Authorization`Required	`string`	Your API key with the Bearer scheme. Example:`Bearer hk_TU_API_KEY`

AuthorizationRequired

string

Your API key with the Bearer scheme.

Example:Bearer hk_TU_API_KEY

Request body

This endpoint takes no request body.

Successful responses

200

The link.

Response example

{
  "success": true,
  "data": {
    "domain": "h0b.co",
    "code": "a1b2c3d",
    "shortUrl": "https://h0b.co/a1b2c3d",
    "longUrl": "https://example.com/landing?utm_source=sms",
    "isAlias": false,
    "status": "active",
    "domainStatus": "active",
    "expiresAt": null,
    "createdAt": "2026-09-23T15:04:05Z",
    "clicks": 0,
    "uniqueClicks": 0,
    "firstClickAt": null,
    "lastClickAt": null
  },
  "meta": {
    "requestId": "8f0c0e2a4b1d4c8f",
    "clientIp": "203.0.113.45",
    "timestamp": "2026-09-23T18:30:00+00:00",
    "responseTimeMs": 7.2
  }
}

The example values are illustrative.

Response fields

Name	Type	Description and rules
`success`Always present	`boolean`
`data`Always present	`object`
`data.domain`Always present	`string`	Domain of the link, lowercase. If the domain no longer belongs to your organization (`domainStatus: released`), it is the name it had.
`data.code`Always present	`string`	Link code, lowercase: 7 `0-9a-z` characters when the service generates it, or the alias chosen at creation. Unique per domain.
`data.shortUrl`Always present	`string`	The full short URL: always `https://{domain}/{code}`. Format:`uri`
`data.longUrl`Always present	`string`	Destination URL. Format:`uri`
`data.isAlias`Always present	`boolean`	`true` when the code was chosen by whoever created the link (the `code` field on creation); `false` when the service generated it.
`data.status`Always present	`string`	`active`, `disabled` or `blocked` (and `deleted`, only in the case below). Expired is not a status: an `active` link whose `expiresAt` has passed no longer redirects, but keeps `active`. `blocked` is a link Hablame blocked for security: it does not redirect and cannot be edited, deleted or reactivated through the API; if you think it is a mistake, contact us. Deleted links do not appear in responses, except in the replay of a creation with `Idempotency-Key` whose link was deleted afterwards: it comes as it is, with `deleted`. Allowed values:`active` `disabled` `blocked` `deleted`
`data.domainStatus`	`string`	Whether the domain lets the link open, apart from its own `status`. `active`: it does. `suspended`: the domain is suspended; `released`: the domain no longer belongs to your organization; `pending`: it is an own domain that is not verified yet. With those three the link does not redirect (the visitor gets `404`) even if its `status` is `active`. It comes in the list, when getting a link and when creating, editing or restoring it; if it does not come, treat the link as before the field existed. New values may appear: one you do not know does not mean the link does not open. Allowed values:`active` `pending` `suspended` `released`
`data.expiresAt`Always present	`string`	Expiry in UTC, or `null` if it never expires. May come as `null`. Format:`date-time`
`data.createdAt`Always present	`string`	Creation date, in UTC. Format:`date-time`
`data.clicks`Always present	`integer`	Lifetime visits of the link. A background process consolidates them: a visit can take from seconds to a few minutes to show up. Bots and the previews generated by social networks and chat apps are not counted.
`data.uniqueClicks`Always present	`integer`	Sum of each day’s unique visits: the first visit of the day from each browser. Not distinct people over the life of the link.
`data.firstClickAt`Always present	`string`	First visit, in UTC. `null` if it never received one. May come as `null`. Format:`date-time`
`data.lastClickAt`Always present	`string`	Last visit, in UTC. `null` if it never received one. May come as `null`. Format:`date-time`
`meta`Always present	`object`	Response metadata.
`meta.requestId`Always present	`string`	Unique request identifier (16 hexadecimal characters). It matches the `X-Request-Id` header. Quote it when contacting support. Example:`b9b1704baffab211`
`meta.clientIp`Always present	`string`	IP the API saw your request come from. Useful if your API key only accepts certain networks. Example:`203.0.113.45`
`meta.timestamp`Always present	`string`	Date and time the response was built (ISO 8601 with offset). Format:`date-time`Example:`2026-06-04T19:43:59+00:00`
`meta.responseTimeMs`Always present	`number`	Time (ms) the server took to process the request. Example:`4.24`

Error codes

Every error response has the same shape: success set to false and an error object whose code says what happened. They are grouped here by kind, with the codes this endpoint can return.

Shape of an error response

Name	Type	Description and rules
`success`Always present	`boolean`	Fixed value:`false`
`meta`Always present	`object`	Response metadata.
`meta.requestId`Always present	`string`	Unique request identifier (16 hexadecimal characters). It matches the `X-Request-Id` header. Quote it when contacting support. Example:`b9b1704baffab211`
`meta.clientIp`Always present	`string`	IP the API saw your request come from. Useful if your API key only accepts certain networks. Example:`203.0.113.45`
`meta.timestamp`Always present	`string`	Date and time the response was built (ISO 8601 with offset). Format:`date-time`Example:`2026-06-04T19:43:59+00:00`
`meta.responseTimeMs`Always present	`number`	Time (ms) the server took to process the request. Example:`4.24`
`error`Always present	`object`
`error.code`Always present	`string`	Stable UPPER_SNAKE_CASE identifier. Clients branch on this value. Example:`AUTH_REQUIRED`
`error.legacyCode`	`integer`	Legacy v5 numeric code, only when a bridge exists. Omitted for codes born in v6. Example:`40002`
`error.type`Always present	`string`	URL to the error documentation. Format:`uri`Example:`https://developers.hablame.co/docs/v6/errors/auth-required`
`error.message`Always present	`string`	Human readable text, in English. It is for the developer log, not the end user: do not parse it.
`error.details`Always present	`array<object>`	Structured context (validation issues, affected resource). Empty array when there is no extra context.

Validation

This endpoint does not declare responses of this kind.

Authentication

401Invalid or missing credentials.

401AUTH_REQUIRED
No Bearer token was sent, and every call requires one.
Message the API returns: Authentication is required. Send your API key as `Authorization: Bearer <token>`.
401AUTH_INVALID_KEY
The API key is not recognized: wrong format, revoked or expired.
Message the API returns: The provided API key is invalid or has expired. Please verify the value sent in the `Authorization: Bearer` header.

Permissions

403The API key does not have the URL shortener enabled (or it is turned off for your organization), the key cannot be used from the request network, or the organization is not active.

403AUTH_SERVICE_NOT_ALLOWED
The key is not allowed to use the service behind this endpoint.
Message the API returns: This API key is not authorized to use the requested service.
403AUTH_IP_NOT_ALLOWED
The key only works from certain networks and your IP is not one of them.
Message the API returns: This API key cannot be used from this IP address. The address we saw is in `meta.clientIp`: call from one of the networks allowed for the key, or use a key that allows this one.
403ACCOUNT_NOT_ACTIVE
Your organization is suspended or closed.
Message the API returns: The organization associated with this API key is not active. Please contact support.

Usage limits

429Request limit exceeded.

429RATE_TPS_EXCEEDED
You exceeded your organization quota for this endpoint.
Message the API returns: You have exceeded the allowed request rate for this endpoint. Please wait before retrying.

Resource not found

404No link of your organization with that domain and code (or it was deleted). A link from another organization also returns 404: its existence is not disclosed.

404LINK_NOT_FOUND
No link with that domain and code.
Message the API returns: No short link was found for that domain and code.

Internal errors and availability

This endpoint does not declare responses of this kind.

Other responses

This endpoint does not declare responses of this kind.

See it in the error catalog

Special considerations

This endpoint has no special considerations.

Endpoints

Get a short link

HTTP method and path

What it does

Availability and prerequisites

Authentication and permissions

Limits and operational notes

Path parameters

Query parameters

HTTP headers

Request body

Successful responses

200

Response fields

Error codes

Validation

Authentication

Permissions

Usage limits

Resource not found

Internal errors and availability

Other responses

Special considerations

Related documentation

Guides

Other URL Shortener endpoints

Need help?

Ask for help about this: this endpoint