API Reference

हर REST और OAuth ऑपरेशन को उसके सटीक होस्ट, प्रमाणीकरण विधि, स्कोप, पैरामीटर, अनुरोध फ़ील्ड और प्रतिक्रिया कोड के साथ देखें।

OpenAPI v2.1.0

API का अवलोकन

सार्वजनिक /v2 ऑपरेशन स्कोप वाली API कुंजी या OAuth 2.0 एक्सेस टोकन स्वीकार करते हैं। OAuth प्रबंधन ऑपरेशन की अपनी ब्राउज़र, सेशन या क्लाइंट-क्रेडेंशियल आवश्यकताएँ होती हैं।

Interactive Reference आज़माएं

बेस URL:: https://api.s.id/v2
ऑपरेशन: 38
स्कोप: 10

प्रमाणीकरण

क्रेडेंशियल स्कोप-आधारित हैं। आवश्यक स्कोप न होने पर 403 insufficient_scope मिलता है। केवल वही अनुमति माँगें जिसकी आपके इंटीग्रेशन को आवश्यकता है।

Authorization: Bearer sk_live_...

Endpoints

Endpoint कैटलॉग

ऑपरेशन खोलकर उसका सटीक base URL, प्रमाणीकरण, इनपुट और संभावित प्रतिक्रिया कोड देखें।

Links

GET/linksलिंक सूचीबद्ध करें

Returns a paginated list of the authenticated user's links.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

links:read

पैरामीटर

pagequery · integer
limitquery · integer
searchquery · string
Filter by short code or URL

प्रतिक्रियाएँ

200List of links

401

403

429

POST/linksलिंक बनाएँ

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

links:write

अनुरोध body

long_urlstringआवश्यक
The destination (long) URL
titlestring
custom_slugstring
Custom short code; auto-generated when omitted
passwordstring
Optional password to protect the link
expired_atinteger
Optional expiry as a Unix timestamp (seconds)
domain_aliasstring
Custom domain to use instead of s.id

प्रतिक्रियाएँ

200

401

403

422

429

POST/links/availableSlug की उपलब्धता जाँचें

Checks whether a custom slug is available before creating a link.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

links:read

अनुरोध body

shortstringआवश्यक
domain_aliasstring
Custom domain, if any

प्रतिक्रियाएँ

200Slug is available

401

422Slug is taken or invalid

GET/links/{short}लिंक पाएँ

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

links:read

पैरामीटर

shortpath · stringआवश्यक
The short code of the link

प्रतिक्रियाएँ

200

401

404

PUT/links/{short}लिंक अपडेट करें

Updates a link. All fields are optional; omitted fields are left unchanged. - `password`: set a non-empty string to protect, empty string `""` to remove protection. - `custom_slug`: rename the short code (subject to quota). - `archive_at`: schedule auto-archive on a date (`YYYY-MM-DD`). - `domain_alias`: change the custom domain (must be owned by the user).

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

links:write

पैरामीटर

shortpath · stringआवश्यक
The short code of the link

अनुरोध body

long_urlstring
New destination URL
titlestring
custom_slugstring
Rename the short code (subject to plan quota)
passwordstring
Set a password (`""` removes existing protection)
disposableboolean
Mark link as disposable (expires after first click)
adultboolean
Flag link as adult content
archive_atstring
Schedule auto-archive on this date (YYYY-MM-DD)
domain_aliasstring
Change the custom domain (must be owned by the user)

प्रतिक्रियाएँ

200

401

403

404

422

429

DELETE/links/{short}लिंक संग्रहित करें

Archives (soft-deletes) a link. The short code stops resolving. Use `POST /links/{short}/unarchive` to restore.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

links:archive

पैरामीटर

shortpath · stringआवश्यक
The short code of the link

प्रतिक्रियाएँ

200Link archived

401

404

429

POST/links/{short}/unarchiveसंग्रहित लिंक पुनर्स्थापित करें

Restores a previously archived link, making its short code resolve again.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

links:write

पैरामीटर

shortpath · stringआवश्यक
The short code of the archived link

प्रतिक्रियाएँ

200Link restored

401

403

404

429

GET/links/{short}/statsलिंक क्लिक टाइमलाइन

Returns a date-bucketed click-count timeline for the link.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

links:analytics

पैरामीटर

shortpath · stringआवश्यक
startquery · string
endquery · string

प्रतिक्रियाएँ

200Click timeline

401

403

404

429

GET/links/{short}/stats/lifetimeकुल आजीवन क्लिक

Returns the all-time total click count for a single link.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

links:analytics

पैरामीटर

shortpath · stringआवश्यक

प्रतिक्रियाएँ

200Lifetime click count

401

403

404

429

POST/links/bulkएक साथ कई लिंक बनाएँ

Create up to 100 short links in a single request. Requires a subscription plan with bulk shortening enabled. Each item reports individual success/failure — the overall request always returns 200 even if some items fail.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

links:write

अनुरोध body

linksarray<object>आवश्यक

प्रतिक्रियाएँ

200Bulk result — individual items may have success=false

401

402Plan upgrade required (bulk shortening not in plan)

403

User

GET/userप्रमाणित उपयोगकर्ता पाएँ

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

user:read

प्रतिक्रियाएँ

200User profile

401

429

GET/quotaअकाउंट कोटा पाएँ

Returns the authenticated user's current plan limits and usage counters.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

user:read

प्रतिक्रियाएँ

200Account quota

401

429

Microsites

GET/micrositesMicrosite सूचीबद्ध करें

Returns a paginated list of microsites owned by the authenticated user.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

microsites:read

पैरामीटर

limitquery · integer
afterquery · string
Cursor for the next page (opaque string from previous response)

प्रतिक्रियाएँ

200List of microsites

401

403

POST/micrositesMicrosite बनाएँ

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

microsites:write

अनुरोध body

slugstringआवश्यक
URL-safe identifier (alphanumeric + hyphens/underscores)
titlestringआवश्यक
kindstringआवश्यक
Microsite category (e.g. `personal_branding`, `brand`, `other`)
themestring
Theme slug (optional, defaults to the platform default)

प्रतिक्रियाएँ

200Microsite created

400Validation error (slug already taken, quota exceeded, etc.)

401

403

GET/microsites/{slug}Microsite पाएँ

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

microsites:read

पैरामीटर

slugpath · stringआवश्यक

प्रतिक्रियाएँ

200Microsite detail

401

403

404Microsite not found

PUT/microsites/{slug}Microsite अपडेट करें

Patches title, description, and/or visibility. All fields are optional.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

microsites:write

पैरामीटर

slugpath · stringआवश्यक

अनुरोध body

titlestring
descriptionstring
hideboolean
Set `true` to hide the microsite from public (requires plan that supports visibility toggle)

प्रतिक्रियाएँ

200Updated microsite

401

403

404Microsite not found

DELETE/microsites/{slug}Microsite हटाएँ

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

microsites:delete

पैरामीटर

slugpath · stringआवश्यक

प्रतिक्रियाएँ

200Microsite deleted

401

403

404Microsite not found

POST/microsites/availableMicrosite slug की उपलब्धता जाँचें

Checks whether a microsite slug is available before creating a microsite.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

microsites:read

अनुरोध body

slugstringआवश्यक

प्रतिक्रियाएँ

200Slug availability result

401

403

429

GET/microsites/{slug}/componentsMicrosite कंपोनेंट सूचीबद्ध करें

Returns the components belonging to a microsite, in display order.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

microsites:read

पैरामीटर

slugpath · stringआवश्यक
The slug of the microsite

प्रतिक्रियाएँ

200List of microsite components

401

403

404

429

POST/microsites/{slug}/componentsMicrosite कंपोनेंट जोड़ें

Adds a new component to a microsite. The body is `{ kind, data, tag? }`. The shape of the `data` object depends on `kind`. Unknown fields are ignored, validation is per-kind, and invalid input returns `422`. All color fields are hex strings (e.g. `#1a56db`). **Kinds:** `PROFILE`, `LINK`, `HORIZONTAL_LINK`, `TEXT`, `IMAGE`, `MEDIA`, `DIVIDER`, `COUNTDOWN`, `MAPS`, `IMAGE_SLIDE`, `CV`, `AUTOPLAY_MUSIC`, `CONTACT`, `CALENDAR`, `SHOP_LISTING`, `SHOP_ITEM`, `SHOP_LEADERBOARD`. **Rules:** - `PROFILE`, `CV` and `AUTOPLAY_MUSIC` are unique — at most one per microsite. - `IMAGE_SLIDE` requires a plan with the Image Slide feature. - On create the password is always stored empty — set or change it via update (`PUT`). - Image fields (`image`, `imageBackground`, slide `image`) must be a local asset path, not a remote URL — they must match `[/.a-zA-Z0-9_-]+.(jpg|jpeg|png|svg|webp|gif|bmp)`; any value containing a scheme (`https://`), `//`, or `..` is rejected. **Shared field groups** (a kind that lists a group accepts all of its fields inside `data`): - **Button styling** (`LINK`, `CONTACT`, `CALENDAR`): `icon` (string, max 255), `textFont` (string, max 100), `textPosition` (string, max 100), `buttonEffect` (string, max 100), `buttonColor` (hex, max 20), `buttonBorderColor` (hex, max 20), `buttonIconBackground` (hex, max 20), `buttonShadowColor` (hex, max 20). - **Spoiler reveal** (`TEXT`, `IMAGE`, `MEDIA`, `MAPS`, `IMAGE_SLIDE`, `SHOP_LEADERBOARD`): `isSpoiler` (bool), `spoilerButtonText` (string, max 140), `spoilerButtonTextPosition` (string, max 100), `spoilerButtonIcon` (string), `spoilerButtonColor` (hex, max 20), `spoilerButtonFont` (string, max 100), `spoilerBackground` (string, max 100), `spoilerBackgroundOpacity` (string, max 100), `spoilerButtonBorderColor` (hex, max 20), `spoilerButtonIconBackground` (hex, max 20), `spoilerButtonShadowColor` (hex, max 20). - **Password protection** (`LINK`, `TEXT`, `IMAGE`, `MEDIA`, `MAPS`, `IMAGE_SLIDE`, `CONTACT`, `CV`, `SHOP_LEADERBOARD`): `passwordActive` (bool), `password` (string, max 255 — set via update only), `passwordMessage` (string, max 255).

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

microsites:write

पैरामीटर

slugpath · stringआवश्यक
The slug of the microsite

अनुरोध body

kindstringआवश्यक
Component kind. The shape of `data` depends on this value.
dataobjectआवश्यक
Kind-specific component data. Its shape depends on `kind`. See the operation description and examples below.
tagstring
Optional grouping tag

प्रतिक्रियाएँ

200Component created

401

403

404

422

429

PUT/microsites/{slug}/components/{componentId}Microsite कंपोनेंट अपडेट करें

Updates a single microsite component.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

microsites:write

पैरामीटर

slugpath · stringआवश्यक
The slug of the microsite
componentIdpath · stringआवश्यक
The component ID

अनुरोध body

activebooleanआवश्यक
Whether the component is shown
kindstringआवश्यक
Component kind (e.g. `LINK`, `PROFILE`, `TEXT`)
dataobjectआवश्यक
Kind-specific component data

प्रतिक्रियाएँ

200Component updated

401

403

404

422

429

DELETE/microsites/{slug}/components/{componentId}Microsite कंपोनेंट हटाएँ

Deletes a single microsite component.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

microsites:delete

पैरामीटर

slugpath · stringआवश्यक
The slug of the microsite
componentIdpath · stringआवश्यक
The component ID

प्रतिक्रियाएँ

200Component deleted

401

403

404

429

POST/microsites/{slug}/components/orderMicrosite कंपोनेंट का क्रम बदलें

Reorders a microsite's components according to the provided list of component IDs.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

microsites:write

पैरामीटर

slugpath · stringआवश्यक
The slug of the microsite

अनुरोध body

ordersarray<string>आवश्यक
Component IDs in the desired display order

प्रतिक्रियाएँ

200Components reordered

401

403

404

422

429

Analytics

GET/statsअकाउंट-स्तरीय क्लिक एनालिटिक्स

Returns a timeline of clicks plus breakdowns by top links, referers, locations, devices, and browsers for the authenticated account. Date range is gated by subscription plan.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

links:analytics

पैरामीटर

startquery · string
Start date (YYYY-MM-DD). Defaults to 30 days ago.
endquery · string
End date (YYYY-MM-DD). Defaults to today.
additionalquery · boolean
Include referer, location, device, browser breakdowns

प्रतिक्रियाएँ

200Account analytics

401

403

QR

GET/qrग्लोबल QR सेटिंग पाएँ

Returns the account-level (global) QR code settings applied to QR codes by default.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

qr:read

प्रतिक्रियाएँ

200Global QR settings

401

403

429

PUT/qrग्लोबल QR सेटिंग कस्टमाइज़ करें

Updates the account-level (global) QR code settings. All fields are optional; omitted fields are left unchanged.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

qr:write

अनुरोध body

logostring
URL of the logo image embedded in the QR code
colorstring
Foreground color as a hex value, e.g. #1a56db

प्रतिक्रियाएँ

200Updated global QR settings

401

403

422

429

GET/links/{short}/qrलिंक की QR सेटिंग पाएँ

Returns the QR code settings for a single link.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

qr:read

पैरामीटर

shortpath · stringआवश्यक
The short code of the link

प्रतिक्रियाएँ

200Link QR settings

401

403

404

429

PUT/links/{short}/qrलिंक की QR सेटिंग कस्टमाइज़ करें

Updates the QR code settings for a single link. All fields are optional; omitted fields are left unchanged.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी या OAuth 2.0

Scope

qr:write

पैरामीटर

shortpath · stringआवश्यक
The short code of the link

अनुरोध body

logostring
URL of the logo image embedded in the QR code
colorstring
Foreground color as a hex value, e.g. #1a56db

प्रतिक्रियाएँ

200Updated link QR settings

401

403

404

422

429

OAuth 2.0

GET/oauth/authorizeसहमति स्क्रीन का डेटा पाएँ

A plain browser navigation here (no `Accept: application/json`) 302-redirects to the dash.s.id consent UI, preserving the query string. With `Accept: application/json`, returns application name, logo, and requested scopes for the consent UI to render.

बेस URL: https://api.s.id
प्रमाणीकरण: API कुंजी

पैरामीटर

client_idquery · stringआवश्यक
redirect_uriquery · stringआवश्यक
response_typequery · stringआवश्यक
scopequery · string
statequery · string
Recommended. Opaque value for CSRF protection. Returned unchanged in the redirect.

प्रतिक्रियाएँ

200Consent screen data

400Bad request

POST/oauth/tokenकोड या refresh token एक्सचेंज करें

बेस URL: https://api.s.id
प्रमाणीकरण: API कुंजी

अनुरोध body

grant_typestring
codestring
redirect_uristring
client_idstring
client_secretstring
refresh_tokenstring

प्रतिक्रियाएँ

200Token response

400Invalid grant, unsupported_grant_type, or invalid_client

401Invalid client credentials

POST/oauth/revokeटोकन रद्द करें

Revokes an access or refresh token. Always returns 200 OK regardless of whether the token was valid (RFC 7009).

बेस URL: https://api.s.id
प्रमाणीकरण: API कुंजी

अनुरोध body

tokenstringआवश्यक

प्रतिक्रियाएँ

200Token revoked

POST/oauth/introspectटोकन की जाँच करें

Reports whether a token is currently active and, if so, which scopes and client it belongs to (RFC 7662). Client-credential protected: `client_id`/`client_secret` identify the caller, not the token owner. Always returns `200` — including for an unknown, expired, or revoked token (`{"active": false}`) — to avoid leaking token validity to unauthenticated probing.

बेस URL: https://api.s.id
प्रमाणीकरण: API कुंजी

अनुरोध body

tokenstringआवश्यक
client_idstringआवश्यक
client_secretstringआवश्यक

प्रतिक्रियाएँ

200Introspection result

400Missing token/client_id, or invalid client credentials

GET/oauth/userinfoअधिकृत उपयोगकर्ता प्रोफ़ाइल पाएँ

Returns the profile of the user who authorized the OAuth app. Requires `Authorization: Bearer <access_token>` (the OAuth access token, not an sk_live_ key).

बेस URL: https://api.s.id
प्रमाणीकरण: OAuth 2.0

Scope

user:read

प्रतिक्रियाएँ

200User profile

401Unauthorized

GET/.well-known/oauth-authorization-serverOAuth 2.0 ऑथराइज़ेशन सर्वर मेटाडेटा

RFC 8414 discovery document advertising every OAuth endpoint URL, supported scopes, and PKCE methods, so standards-compliant client libraries can configure themselves instead of hard-coding s.id's URLs.

बेस URL: https://api.s.id
प्रमाणीकरण: API कुंजी

प्रतिक्रियाएँ

200Authorization server metadata

GET/api/user/oauth/appsवर्तमान उपयोगकर्ता द्वारा अधिकृत ऐप सूचीबद्ध करें

Returns all OAuth clients that have active tokens for the authenticated user. Auth: user session cookie (not API key).

बेस URL: https://api.s.id
प्रमाणीकरण: API कुंजी

प्रतिक्रियाएँ

200List of connected apps

401Unauthorized

DELETE/api/user/oauth/apps/{clientId}ऐप के सभी टोकन रद्द करें

Revokes all active tokens granted by the current user to the specified OAuth client.

बेस URL: https://api.s.id
प्रमाणीकरण: API कुंजी

पैरामीटर

clientIdpath · stringआवश्यक

प्रतिक्रियाएँ

200App access revoked

401Unauthorized

404App not found

Integrations

POST/integrations/make/webhook/unsubscribeMake.com webhook की सदस्यता हटाएँ

Removes a previously registered Make.com scenario webhook subscription. Authenticated via DeveloperAPIAuth with no scope requirement.

बेस URL: https://api.s.id/v2
प्रमाणीकरण: API कुंजी

प्रतिक्रियाएँ

200Unsubscribed

401Unauthorized

Scope Reference

links:read

लिंक सूचीबद्ध और पढ़ें

links:write

लिंक बनाएँ और अपडेट करें (बनाना, संपादित करना, पुनर्स्थापित करना)

links:archive

लिंक संग्रहित करें

links:analytics

प्रति लिंक क्लिक आँकड़े और आजीवन संख्या पढ़ें

qr:read

QR कोड सेटिंग पढ़ें (ग्लोबल और प्रति लिंक)

qr:write

QR कोड सेटिंग कस्टमाइज़ करें (ग्लोबल और प्रति लिंक)

user:read

प्रमाणित उपयोगकर्ता प्रोफ़ाइल और अकाउंट कोटा पढ़ें

microsites:read

Microsite पढ़ें

microsites:write

Microsite कंपोनेंट बनाएँ, अपडेट करें और प्रबंधित करें

microsites:delete

Microsite और उनके कंपोनेंट हटाएँ

Rate Limits

डिफ़ॉल्ट सीमा प्रति क्रेडेंशियल 38 अनुरोध प्रति मिनट है—प्रति API कुंजी या OAuth एक्सेस टोकन। OAuth ऐप के सभी टोकन पर कुल सीमा 500 अनुरोध प्रति मिनट भी है।

सामान्य त्रुटि प्रतिक्रियाएँ

400: अनुरोध का प्रारूप गलत है या समर्थित नहीं है
401: क्रेडेंशियल अनुपस्थित, अमान्य, रद्द या समाप्त है
403: क्रेडेंशियल में आवश्यक स्कोप नहीं है
404: माँगा गया संसाधन नहीं मिला
422: अनुरोध सत्यापन विफल रहा
429: दर सीमा पार हो गई

बनाना शुरू करने के लिए तैयार हैं?

मिनटों में API key बनाएं। मुफ़्त tier शामिल, कोई क्रेडिट कार्ड आवश्यक नहीं।

अपनी API key पाएं