---
title: "List Short URLs"
method: GET
path: "/v2/links"
tags: ["links"]
---

# List Short URLs

`GET /v2/links`

.

## Response `200`

Successfully retrieved the Links

- ListUrlResponse
  - `meta` MetadataDTO
    - `timestamp` integer, required — Transaction's date in timestamp
    - `transactionId` string, required — Id for the current transaction (Endpoint's call)
    - `explain` string — Explain string in case of failure
  - `pagination` PageDTO — pagination information
    - `offset` string — start point
    - `limit` integer — items to be displayed by page
    - `next` string — next item to be consulted in the following invocation
    - `page` integer — current page of data
    - `pages` integer — total amount of pages in the response
    - `total` integer — total amount of items in the response
  - `items` UrlPojo[] — List (array) of short URLs created.
    - `id` string — Unique identifier of the short URL.
    - `longUrl` string — <p>URL destination name.</p> <p>URL link to which the short URL will redirect.</p>
    - `data` object — <p><b>Optional.</b> This array can be used by the customer to enter and store additional information about the short URL.</p><p><b>This additional information must be set in JSON format at key/value level.</b></p><p>For example:</p><p>'data': { 'name': 'Elizabeth Smith', 'email': 'eli7218@mailpoof.com' }</p>
    - `externalId` string — Alphanumeric identifier used for reporting purposes.
    - `callbacks` string[] — <p>Webhook URL to notify about the events of the short URL.</p><p>The URL is the external callback where the events of the short URL will be registered and published. The following short URL status sent to your callback URL will be the status to be recorded in the callback once end user has clicked on the short URL:</p><p><ul></p><p><li><code>'open'</code>: End user clicked on the short URL link. </li></p></ul></p>
    - `shortLink` string — <p>Short URL link.</p> <p>Copy and paste this short URL into your browser to test it.</p>
    - `date` string, date-time — <p>Date when the short URL was created.</p> <p>The date is represented with date in UTC Zulu format: (yyyy-mm-dd-Thh:mm:ss.ssZ).</p>

## Other responses

- `401` — Unauthorized
- `410` — Token expired
- `500` — Internal server error

---

[API](https://skmtc.net/messangi/apis/raven.md) · [All operations](https://skmtc.net/messangi/apis/raven/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/messangi/raven/revisions/c87f398fa338/schema)