Desarrolladores

APIs that can be used to work with State programmatically

Get links

This API method returns a list of short links.

Endpoint

GET/links

Authorization required.

Query parameters

Parameter	Description
domain_id	Domain ID. You can retrieve available domains via the Domains API
folder_id	filter by folder id. You can get IDs from Folders API
tag_id	filter by tag id. You can get IDs from Tags API
search	Case-insensitive string to match anywhere in the URL, its title, or an exact match with the slug
page	the page number for pagination, default 0
limit	the number of items per page. default 25. available values: 10,25,50,75,100
order	you can order by following fields: short_url, original, clicks, created_at. i.e. order=clicks:desc

Request

cURL

curl https://state.sk/api/links \
    -H 'x-api-key: state_xxxxxxxxxx'

Response

{ 
    "items": [
        {
        "id": "id-1",
        "org_id": "org-1",
        "user_id": "user-1",
        "folder_id": 1,
        "domain_id": 1,
        "domain": "state.sk",
        "slug": "ireland",
        "url": "https://mediavibes.app/mv/BoYlpxe0Ys",
        "title": "Collection Ireland",
        "expires_at": null,
        "expires_after": 0,
        "expire_url": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_campaign": null,
        "utm_term": null,
        "utm_content": null,
        "utm_reference": null,
        "created_at": "2025-10-07T13:12:01.761Z",
        "updated_at": "2025-10-07T13:12:01.761Z",
        "ios": "https://apps.apple.com/app/cloomba/id6670720223",
        "android": "https://play.google.com/store/apps/details?id=com.allwhitetown.cloomba",
        "redirect_code": null,
        "has_password": false,
        "short_url": "https://state.sk/ireland",
        "clicks": 4,
        "clicked_at": "2025-10-15T13:12:01.761Z",
        "folder": {
            "id": 1,
            "name": "Demo",
            "color": "pink"
        },
        "tags": [
            { "id": 1, "name": "Important", "color": "blue" },
            { "id": 2, "name": "Marketing", "color": "green" }
        ],
        "ab": [
            { "id": 1, "url": "https://instagram.com", "percent": 20 },
            { "id": 2, "url": "https://reddit.com", "percent": 20 }
        ],
        "geo": [
            { "id": 2, "url": "https://claude.ai/new", "country": "FR" },
            { "id": 3, "url": "https://www.perplexity.ai/", "country": "DE" }
        ]
        }
    ],
    "total": 1,
    "offset": 0,
    "limit": 25
}

Detailed information about the link fields in the Link article.

← Bio Create link →