Skip to main content
GET
/
links
cURL
curl --request GET \
  --url https://api.bsy.sh/v1/links \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": {
    "links": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "long_url": "<string>",
        "title": "<string>",
        "favicon": "<string>",
        "custom_link": "<string>",
        "tags": [
          "<string>"
        ],
        "has_utm": true,
        "has_opengraph": true,
        "has_android_targeting": true,
        "android_target_url": "<string>",
        "has_ios_targeting": true,
        "ios_target_url": "<string>",
        "has_windows_targeting": true,
        "windows_target_url": "<string>",
        "has_linux_targeting": true,
        "linux_target_url": "<string>",
        "has_geo_targeting": true,
        "has_cloaking": true,
        "has_password": true,
        "password_logo": "<string>",
        "has_expiration": true,
        "expiration": "2023-11-07T05:31:56Z",
        "expiration_clicks": "<string>",
        "is_expired": true,
        "is_clicked": true,
        "last_clicked": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "bitsy_url": "<string>",
        "custom_url": "<string>",
        "utm": {
          "utm_source": "<string>",
          "utm_medium": "<string>",
          "utm_campaign": "<string>",
          "utm_term": "<string>",
          "utm_content": "<string>"
        },
        "opengraph": {
          "meta_title": "<string>",
          "meta_description": "<string>",
          "meta_image": "<string>"
        },
        "geo_targets": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "target_url": "<string>",
            "country": {
              "iso2": "<string>",
              "name": "<string>"
            }
          }
        ],
        "shareable_analytics": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "start_date": "2023-12-25",
            "end_date": "2023-12-25",
            "created_at": "2023-11-07T05:31:56Z",
            "share_url": "<string>",
            "has_password": true
          }
        ]
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
title
string

Title of the link, optional.

Maximum string length: 150
​
tag
string

Tag of the link, optional.

Maximum string length: 150
​
is_clicked
enum<string>

Indicates if the link has been clicked.

Available options:
true,
false
​
has_password
enum<string>

Indicates if a password is required to access the link.

Available options:
true,
false
​
start_date
string

Start date for filtering links. Must be in 'YYYY-MM-DD' format.

Pattern: ^\d{4}-\d{2}-\d{2}$
​
end_date
string

End date for filtering links. Must be in 'YYYY-MM-DD' format.

Pattern: ^\d{4}-\d{2}-\d{2}$
​
offset
string

Offset for pagination.

Pattern: ^\d+$
​
limit
string

Limit for pagination.

Pattern: ^\d+$

Response

A list of Bitsy Links

​
status
enum<string>
required
Available options:
success
​
data
object
required