List Links - s.id Public API

Request

Query Params

count_only

boolean

optional

Use this param if wants to return only items count

page

integer

optional

Current page

Header Params

X-Auth-Id

string

required

X-Auth-Key

string

required

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.s.id/v1/links?count_only&page' \
--header 'X-Auth-Id;' \
--header 'X-Auth-Key;'

Responses

🟢200OK

application/json

Body

code

integer

required

total

integer

required

data

array[object (LinkItem) {13}]

required

id

integer

required

created_at

string <date-time>

required

updated_at

string <date-time>

required

short

string

required

long_url

string

required

blocked

boolean

required

blocked_reason

string

optional

blocked_at

string <date-time>

required

microsite

boolean

required

protected

boolean

required

disposable

boolean

required

adult

boolean

required

archive_at

string <date-time>

required

Example

{
    "code": 200,
    "total": -1,
    "data": [
        {
            "_id": "6673610e22b2eaa01abe4873",
            "id": 414736,
            "created_at": "2024-06-19T22:51:58.036Z",
            "updated_at": "2024-06-19T23:12:42.774Z",
            "short": "X2345",
            "long_url": "https://example.com/test-link2",
            "blocked": false,
            "blocked_reason": null,
            "blocked_at": null,
            "microsite": false,
            "protected": false,
            "disposable": false,
            "adult": false,
            "archive_at": null
        },
        {
            "_id": "6673607222b2eaa01abe4871",
            "id": 414735,
            "created_at": "2024-06-19T22:49:22.933Z",
            "updated_at": "2024-06-19T22:49:22.933Z",
            "short": "1JTh",
            "long_url": "https://example.com/test-link1",
            "blocked": null,
            "blocked_reason": null,
            "blocked_at": null,
            "microsite": false,
            "protected": false,
            "disposable": false,
            "adult": false,
            "archive_at": null
        },
        {
            "_id": "6673603bbc4a760f4bbb1ba9",
            "id": 414734,
            "created_at": "2024-06-19T22:48:27.5Z",
            "updated_at": "2024-06-19T22:48:27.5Z",
            "short": "1JTg",
            "long_url": "https://example.com/test-link1",
            "blocked": null,
            "blocked_reason": null,
            "blocked_at": null,
            "microsite": false,
            "protected": false,
            "disposable": false,
            "adult": false,
            "archive_at": null
        },
        {
            "_id": "6672cf23bbcd8e6f8d50c8c5",
            "id": 414733,
            "created_at": "2024-06-19T12:29:23.116Z",
            "updated_at": "2024-06-19T12:29:23.116Z",
            "short": "1JTf",
            "long_url": "https://example.com/example-1",
            "blocked": null,
            "blocked_reason": null,
            "blocked_at": null,
            "microsite": false,
            "protected": false,
            "disposable": false,
            "adult": false,
            "archive_at": null
        }
    ]
}