API v2 Shortener

Create and manage short links from your app. Base URL: https://api.s.id/v2. Current version 2.0.0, and the full specification is available in OpenAPI format.

Interactive reference

Authentication

Send an API key sk_live_... or an OAuth 2.0 access token in the Authorization: Bearer header. Create API keys in Dashboard > Developer; each key can only use the scopes you choose.

Scope	Access
`links:read`	List and read links
`links:write`	Create and update links (create, edit, restore)
`links:archive`	Archive links
`links:analytics`	Read per-link click statistics and lifetime counts

http

Authorization: Bearer sk_live_...

Full authentication guide

Create a link

Send POST /links with the destination URL. A slug is generated automatically if custom_slug is left empty.

bash

curl -X POST https://api.s.id/v2/links \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"long_url": "https://example.com/long-url", "custom_slug": "[your-alias]"}'

Field	Type	Required	Description
`long_url`	`string`	Yes	Destination URL
`title`	`string`	No	Link title
`custom_slug`	`string`	No	Custom slug; generated automatically when empty
`password`	`string`	No	Password that protects the link
`expired_at`	`integer`	No	Expiry time as a Unix timestamp (seconds)
`domain_alias`	`string`	No	Custom domain used instead of s.id

Example response:

json

{
  "data": {
    "id": 123,
    "short": "[your-alias]",
    "short_url": "https://s.id/[your-alias]",
    "long_url": "https://example.com/long-url",
    "microsite": false,
    "protected": false,
    "disposable": false,
    "adult": false
  },
  "message": "link_created"
}

Endpoints

Links

GET/linksList links

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

Base URL: https://api.s.id/v2 · Scope: links:read

Parameters

Field	In	Type	Required	Description
`page`	query	`integer`	No
`limit`	query	`integer`	No
`search`	query	`string`	No	Filter by short code or URL

Responses

Code	Description
`200`	List of links
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

POST/linksCreate a link

Base URL: https://api.s.id/v2 · Scope: links:write

Request body

Field	Type	Required	Description
`long_url`	`string`	Yes	The destination (long) URL
`title`	`string`	No
`custom_slug`	`string`	No	Custom short code; auto-generated when omitted
`password`	`string`	No	Optional password to protect the link
`expired_at`	`integer`	No	Optional expiry as a Unix timestamp (seconds)
`domain_alias`	`string`	No	Custom domain to use instead of s.id

Responses

Code	Description
`200`	A single link
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`422`	Request validation failed
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

POST/links/availableCheck slug availability

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

Base URL: https://api.s.id/v2 · Scope: links:read

Request body

Field	Type	Required	Description
`short`	`string`	Yes
`domain_alias`	`string`	No	Custom domain, if any

Responses

Code	Description
`200`	Slug is available
`401`	Missing or invalid API key
`422`	Slug is taken or invalid

GET/links/{short}Get a link

Base URL: https://api.s.id/v2 · Scope: links:read

Parameters

Field	In	Type	Required	Description
`short`	path	`string`	Yes	The short code of the link

Responses

Code	Description
`200`	A single link
`401`	Missing or invalid API key
`404`	Resource not found

PUT/links/{short}Update a link

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).

Base URL: https://api.s.id/v2 · Scope: links:write

Parameters

Field	In	Type	Required	Description
`short`	path	`string`	Yes	The short code of the link

Request body

Field	Type	Required	Description
`long_url`	`string`	No	New destination URL
`title`	`string`	No
`custom_slug`	`string`	No	Rename the short code (subject to plan quota)
`password`	`string`	No	Set a password (`""` removes existing protection)
`disposable`	`boolean`	No	Mark link as disposable (expires after first click)
`adult`	`boolean`	No	Flag link as adult content
`archive_at`	`string`	No	Schedule auto-archive on this date (YYYY-MM-DD)
`domain_alias`	`string`	No	Change the custom domain (must be owned by the user)

Responses

Code	Description
`200`	A single link
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`422`	Request validation failed
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

DELETE/links/{short}Archive a link

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

Base URL: https://api.s.id/v2 · Scope: links:archive

Parameters

Field	In	Type	Required	Description
`short`	path	`string`	Yes	The short code of the link

Responses

Code	Description
`200`	Link archived
`401`	Missing or invalid API key
`404`	Resource not found
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

POST/links/{short}/unarchiveRestore an archived link

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

Base URL: https://api.s.id/v2 · Scope: links:write

Parameters

Field	In	Type	Required	Description
`short`	path	`string`	Yes	The short code of the archived link

Responses

Code	Description
`200`	Link restored
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

GET/links/{short}/statsLink click timeline

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

Base URL: https://api.s.id/v2 · Scope: links:analytics

Parameters

Field	In	Type	Required
`short`	path	`string`	Yes
`start`	query	`string`	No
`end`	query	`string`	No

Responses

Code	Description
`200`	Click timeline
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

GET/links/{short}/stats/lifetimeLifetime click count

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

Base URL: https://api.s.id/v2 · Scope: links:analytics

Parameters

Field	In	Type	Required	Description
`short`	path	`string`	Yes

Responses

Code	Description
`200`	Lifetime click count
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

POST/links/bulkBulk create links

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.

Base URL: https://api.s.id/v2 · Scope: links:write

Request body

Field	Type	Required	Description
`links`	`object[]`	Yes

Responses

Code	Description
`200`	Bulk result — individual items may have success=false
`401`	Missing or invalid API key
`402`	Plan upgrade required (bulk shortening not in plan)
`403`	API key lacks the required scope

User

GET/userGet authenticated user

Base URL: https://api.s.id/v2 · Scope: user:read

Responses

Code	Description
`200`	User profile
`401`	Missing or invalid API key
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

GET/quotaGet account quota

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

Base URL: https://api.s.id/v2 · Scope: user:read

Responses

Code	Description
`200`	Account quota
`401`	Missing or invalid API key
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

QR

GET/qrGet global QR settings

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

Base URL: https://api.s.id/v2 · Scope: qr:read

Responses

Code	Description
`200`	Global QR settings
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

PUT/qrCustomize global QR settings

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

Base URL: https://api.s.id/v2 · Scope: qr:write

Request body

Field	Type	Required	Description
`logo`	`string`	No	URL of the logo image embedded in the QR code
`color`	`string`	No	Foreground color as a hex value, e.g. #1a56db

Responses

Code	Description
`200`	Updated global QR settings
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`422`	Request validation failed
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

GET/links/{short}/qrGet a link's QR settings

Returns the QR code settings for a single link.

Base URL: https://api.s.id/v2 · Scope: qr:read

Parameters

Field	In	Type	Required	Description
`short`	path	`string`	Yes	The short code of the link

Responses

Code	Description
`200`	Link QR settings
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

PUT/links/{short}/qrCustomize a link's QR settings

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

Base URL: https://api.s.id/v2 · Scope: qr:write

Parameters

Field	In	Type	Required	Description
`short`	path	`string`	Yes	The short code of the link

Request body

Field	Type	Required	Description
`logo`	`string`	No	URL of the logo image embedded in the QR code
`color`	`string`	No	Foreground color as a hex value, e.g. #1a56db

Responses

Code	Description
`200`	Updated link QR settings
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`422`	Request validation failed
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

Microsites

GET/micrositesList microsites

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

Base URL: https://api.s.id/v2 · Scope: microsites:read

Parameters

Field	In	Type	Required	Description
`limit`	query	`integer`	No
`after`	query	`string`	No	Cursor for the next page (opaque string from previous response)

Responses

Code	Description
`200`	List of microsites
`401`	Missing or invalid API key
`403`	API key lacks the required scope

POST/micrositesCreate a microsite

Base URL: https://api.s.id/v2 · Scope: microsites:write

Request body

Field	Type	Required	Description
`slug`	`string`	Yes	URL-safe identifier (alphanumeric + hyphens/underscores)
`title`	`string`	Yes
`kind`	`string`	Yes	Microsite category (e.g. `personal_branding`, `brand`, `other`)
`theme`	`string`	No	Theme slug (optional, defaults to the platform default)

Responses

Code	Description
`200`	Microsite created
`400`	Validation error (slug already taken, quota exceeded, etc.)
`401`	Missing or invalid API key
`403`	API key lacks the required scope

GET/microsites/{slug}Get a microsite

Base URL: https://api.s.id/v2 · Scope: microsites:read

Parameters

Field	In	Type	Required	Description
`slug`	path	`string`	Yes

Responses

Code	Description
`200`	Microsite detail
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Microsite not found

PUT/microsites/{slug}Update a microsite

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

Base URL: https://api.s.id/v2 · Scope: microsites:write

Parameters

Field	In	Type	Required	Description
`slug`	path	`string`	Yes

Request body

Field	Type	Required	Description
`title`	`string`	No
`description`	`string`	No
`hide`	`boolean`	No	Set `true` to hide the microsite from public (requires plan that supports visibility toggle)

Responses

Code	Description
`200`	Updated microsite
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Microsite not found

DELETE/microsites/{slug}Delete a microsite

Base URL: https://api.s.id/v2 · Scope: microsites:delete

Parameters

Field	In	Type	Required	Description
`slug`	path	`string`	Yes

Responses

Code	Description
`200`	Microsite deleted
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Microsite not found

POST/microsites/availableCheck microsite slug availability

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

Base URL: https://api.s.id/v2 · Scope: microsites:read

Request body

Field	Type	Required	Description
`slug`	`string`	Yes

Responses

Code	Description
`200`	Slug availability result
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

GET/microsites/{slug}/componentsList microsite components

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

Base URL: https://api.s.id/v2 · Scope: microsites:read

Parameters

Field	In	Type	Required	Description
`slug`	path	`string`	Yes	The slug of the microsite

Responses

Code	Description
`200`	List of microsite components
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

POST/microsites/{slug}/componentsAdd a microsite component

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).

Base URL: https://api.s.id/v2 · Scope: microsites:write

Parameters

Field	In	Type	Required	Description
`slug`	path	`string`	Yes	The slug of the microsite

Request body

Field	Type	Required	Description
`kind`	`PROFILE \| LINK \| HORIZONTAL_LINK \| TEXT \| IMAGE \| MEDIA \| DIVIDER \| COUNTDOWN \| MAPS \| IMAGE_SLIDE \| CV \| AUTOPLAY_MUSIC \| CONTACT \| CALENDAR \| SHOP_LISTING \| SHOP_ITEM \| SHOP_LEADERBOARD`	Yes	Component kind. The shape of `data` depends on this value.
`data`	`object`	Yes	Kind-specific component data. Its shape depends on `kind`. See the operation description and examples below.
`tag`	`string`	No	Optional grouping tag

Responses

Code	Description
`200`	Component created
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`422`	Request validation failed
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

PUT/microsites/{slug}/components/{componentId}Update a microsite component

Updates a single microsite component.

Base URL: https://api.s.id/v2 · Scope: microsites:write

Parameters

Field	In	Type	Required	Description
`slug`	path	`string`	Yes	The slug of the microsite
`componentId`	path	`string`	Yes	The component ID

Request body

Field	Type	Required	Description
`active`	`boolean`	Yes	Whether the component is shown
`kind`	`string`	Yes	Component kind (e.g. `LINK`, `PROFILE`, `TEXT`)
`data`	`object`	Yes	Kind-specific component data

Responses

Code	Description
`200`	Component updated
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`422`	Request validation failed
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

DELETE/microsites/{slug}/components/{componentId}Delete a microsite component

Deletes a single microsite component.

Base URL: https://api.s.id/v2 · Scope: microsites:delete

Parameters

Field	In	Type	Required	Description
`slug`	path	`string`	Yes	The slug of the microsite
`componentId`	path	`string`	Yes	The component ID

Responses

Code	Description
`200`	Component deleted
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

POST/microsites/{slug}/components/orderReorder microsite components

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

Base URL: https://api.s.id/v2 · Scope: microsites:write

Parameters

Field	In	Type	Required	Description
`slug`	path	`string`	Yes	The slug of the microsite

Request body

Field	Type	Required	Description
`orders`	`string[]`	Yes	Component IDs in the desired display order

Responses

Code	Description
`200`	Components reordered
`401`	Missing or invalid API key
`403`	API key lacks the required scope
`404`	Resource not found
`422`	Request validation failed
`429`	Too many requests. Per-tier limits apply, resolved from your s.id plan: a per-credential per-minute rate limit (`rate_limit_exceeded`) and a daily call quota (`api_quota_exceeded`), both shared across every integration using your credential (sk_live_* key or OAuth token). OAuth apps also have a secondary per-client_id ceiling (`client_rate_limit_exceeded`) across all their users' tokens. See GET /v2/quota for your current standing, and the X-RateLimit-* / X-Quota-* response headers.

OAuth 2.0

GET/oauth/authorizeGet consent screen data

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.

Base URL: https://api.s.id

Parameters

Field	In	Type	Required	Description
`client_id`	query	`string`	Yes
`redirect_uri`	query	`string`	Yes
`response_type`	query	`code`	Yes
`scope`	query	`string`	No
`state`	query	`string`	No	Recommended. Opaque value for CSRF protection. Returned unchanged in the redirect.

Responses

Code	Description
`200`	Consent screen data
`400`	Bad request

POST/oauth/tokenExchange code or refresh token

Base URL: https://api.s.id

Request body

Field	Type	Required
`grant_type`	`authorization_code \| refresh_token`	No
`code`	`string`	No
`redirect_uri`	`string`	No
`client_id`	`string`	No
`client_secret`	`string`	No
`refresh_token`	`string`	No

Responses

Code	Description
`200`	Token response
`400`	Invalid grant, unsupported_grant_type, or invalid_client
`401`	Invalid client credentials

POST/oauth/revokeRevoke a token

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

Base URL: https://api.s.id

Request body

Field	Type	Required	Description
`token`	`string`	Yes

Responses

Code	Description
`200`	Token revoked

POST/oauth/introspectIntrospect a token

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.

Base URL: https://api.s.id

Request body

Field	Type	Required
`token`	`string`	Yes
`client_id`	`string`	Yes
`client_secret`	`string`	Yes

Responses

Code	Description
`200`	Introspection result
`400`	Missing token/client_id, or invalid client credentials

GET/oauth/userinfoGet authorized user profile

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).

Base URL: https://api.s.id · Scope: user:read

Responses

Code	Description
`200`	User profile
`401`	Unauthorized

GET/.well-known/oauth-authorization-serverOAuth 2.0 Authorization Server Metadata

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.

Base URL: https://api.s.id

Responses

Code	Description
`200`	Authorization server metadata

GET/api/user/oauth/appsList apps authorized by the current user

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

Base URL: https://api.s.id

Responses

Code	Description
`200`	List of connected apps
`401`	Unauthorized

DELETE/api/user/oauth/apps/{clientId}Revoke all tokens for an app

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

Base URL: https://api.s.id

Parameters

Field	In	Type	Required	Description
`clientId`	path	`string`	Yes

Responses

Code	Description
`200`	App access revoked
`401`	Unauthorized
`404`	App not found

Analytics

GET/statsAccount-level click analytics

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.

Base URL: https://api.s.id/v2 · Scope: links:analytics

Parameters

Field	In	Type	Required	Description
`start`	query	`string`	No	Start date (YYYY-MM-DD). Defaults to 30 days ago.
`end`	query	`string`	No	End date (YYYY-MM-DD). Defaults to today.
`additional`	query	`boolean`	No	Include referer, location, device, browser breakdowns

Responses

Code	Description
`200`	Account analytics
`401`	Missing or invalid API key
`403`	API key lacks the required scope

Limits and errors

Each credential is limited per minute. Check your quota with GET /quota.

Credential	Limit
API key or OAuth access token	38 requests per minute
OAuth app (all tokens combined)	500 requests per minute

Code	Meaning
`400`	Malformed or unsupported request
`401`	Missing, invalid, revoked, or expired credential
`403`	Credential does not have the required scope
`404`	Requested resource was not found
`422`	Request validation failed
`429`	Rate limit exceeded