Skip to content

Sign in Get API key

API reference

Every endpoint

43 operations across 29 paths, grouped the way the API groups them. Every page is generated from the live OpenAPI document.

Links

List and create every kind of link in one place: short links, QR codes, redirects and website migrations.

GET/linksIndex POST/linksStore GET/links/{id}Show PUT/links/{id}Update DELETE/links/{id}Delete a link GET/links/{id}/historyHistory GET/links/{id}/qrGet a link's QR code GET/links/countCount GET/links/facetsFacets GET/links/filter-pinsFilter pins PUT/links/filter-pinsUpdate filter pins

Redirects

Deprecated: use Links, which creates and manages redirects together with every other kind of link.

GET/redirectList redirects POST/redirectCreate a redirect GET/redirect/{id}Get a redirect PUT/redirect/{id}Update a redirect DELETE/redirect/{id}Delete a redirect GET/redirect/countCount redirects GET/redirect/tagsList redirect tags

Short Links

Deprecated: use Links, which creates and manages short links together with every other kind of link.

GET/linkList short links POST/linkCreate a short link GET/link/{id}Get a short link PUT/link/{id}Update a short link DELETE/link/{id}Delete a short link GET/link/countCount short links GET/link/tagsList short link tags

Bulk Operations

Import, export, update, and delete redirects and short links in bulk.

PUT/bulkUpdate records in bulk DELETE/bulkDelete records in bulk POST/bulk/summarySummary records

Hostnames

Connect hostnames, manage their configuration, and select a routing cluster.

GET/hostList connected hostnames POST/hostCreate a hostname GET/host/{host}Get a hostname PUT/host/{host}Update a hostname DELETE/host/{host}Delete a hostname POST/host/{host}/refreshRe-check a hostname

Workspace

Workspace details and subscriptions.

GET/workspace/{id}Get a workspace GET/workspace/currentGet the current workspace GET/workspace/subscriptionList product subscriptions GET/workspace/subscription/{product}Get one subscription POST/workspace/update/{metaKey}Update one workspace setting

Account & Reference

Account settings plus shared reference and recommendation endpoints.

GET/accountGet the current account GET/shared/pluginsList available plugins GET/shared/typesList record types GET/testVerify your API token