Other API
133 REST endpoints for other, each with its parameters, the response it returns and a runnable curl example. Starts with POST /api/ai/assistant.
POST/api/ai/assistantCreate or update ai assistant
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
message | body | JSON request field |
history | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/ai/domainsCreate or update ai domains
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
keyword | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/ai/metadataCreate or update ai metadata
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
url | body | JSON request field |
originalURL | body | JSON request field |
mode | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/ai/slugAI endpoints
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
url | body | JSON request field |
originalURL | body | JSON request field |
title | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/ai/tagsCreate or update ai tags
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
url | body | JSON request field |
originalURL | body | JSON request field |
title | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/ai/usageGet ai usage
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/announcements=================================================================== Announcements ("What's new") ===================================================================
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/anonymous-links/claimCreate or update anonymous links claim
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
token | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/audit=================================================================== AUDIT LOG ===================================================================
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 7
| Name | In | Description |
|---|---|---|
action | query | Optional query parameter |
userId | query | Optional query parameter |
from | query | Optional query parameter |
to | query | Optional query parameter |
limit | query | Optional query parameter |
offset | query | Optional query parameter |
format | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
POST/api/auth/2fa/backup-codesCreate or update auth 2fa backup codes
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/auth/2fa/disableCreate or update auth 2fa disable
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
password | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/auth/2fa/enableCreate or update auth 2fa enable
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
code | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/auth/2fa/startTwo-factor authentication
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/auth/change-passwordChange password
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
current | body | JSON request field |
password | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/auth/forgotCreate or update auth forgot
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
email | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/auth/loginLog in
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 4
| Name | In | Description |
|---|---|---|
email | body | JSON request field |
password | body | JSON request field |
totp | body | JSON request field |
next | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/auth/magic-linkCreate or update auth magic link
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
email | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/auth/passkeysPasskeys / security keys (WebAuthn registration records)
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/auth/passkeysCreate or update auth passkeys
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 4
| Name | In | Description |
|---|---|---|
credentialId | body | JSON request field |
publicKey | body | JSON request field |
label | body | JSON request field |
transports | body | JSON request field |
Examples in 22 languages and Try it →
Responses
DELETE/api/auth/passkeys/{id}Delete auth passkeys by ID
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/auth/registerSign up
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 4
| Name | In | Description |
|---|---|---|
email | body | JSON request field |
password | body | JSON request field |
name | body | JSON request field |
domain_option | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/auth/resend-verificationCreate or update auth resend verification
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/auth/resetCreate or update auth reset
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
token | body | JSON request field |
password | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/auth/sessionsSessions
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
DELETE/api/auth/sessions/{id}Delete auth sessions by ID
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/auth/sessions/revoke-allCreate or update auth sessions revoke all
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/auth/webauthn/challengeGet auth webauthn challenge
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/compliancecompliance / trust info
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/conversionsGet conversions
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/conversionsConversions ingestion (public, no auth — identified by clid)
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 4
| Name | In | Description |
|---|---|---|
clid | body | JSON request field |
value | body | JSON request field |
source | body | JSON request field |
currency | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/conversions/pixel.gifconversion pixel (1x1 gif) so non-technical users can fire it from a page
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
clid | query | Optional query parameter |
value | query | Optional query parameter |
currency | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
GET/api/developer-packagesGet developer packages
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/docs/askCreate or update docs ask
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
question | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/docs/feedbackGet docs feedback
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
slug | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
POST/api/docs/feedbackCreate or update docs feedback
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
slug | body | JSON request field |
token | body | JSON request field |
helpful | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/export/linksExports
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
domainId | query | Optional query parameter |
q | query | Optional query parameter |
format | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
GET/api/features/activityGet features activity
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
limit | query | Optional query parameter |
kind | query | Optional query parameter |
person | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
GET/api/features/goalsGet features goals
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
domain_id | query | Optional query parameter |
domainId | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
POST/api/features/goalsCreate or update features goals
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 5
| Name | In | Description |
|---|---|---|
domainId | body | JSON request field |
target | body | JSON request field |
deadline | body | JSON request field |
startDate | body | JSON request field |
metric | body | JSON request field |
Examples in 22 languages and Try it →
Responses
DELETE/api/features/goals/{id}Delete features goals by ID
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/features/pinsGet features pins
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
domain_id | query | Optional query parameter |
domainId | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
POST/api/features/pinsCreate or update features pins
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
linkId | body | JSON request field |
Examples in 22 languages and Try it →
Responses
DELETE/api/features/pins/{id}Delete features pins by ID
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/features/reportsGet features reports
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/features/reportsCreate or update features reports
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
email | body | JSON request field |
frequency | body | JSON request field |
domainId | body | JSON request field |
Examples in 22 languages and Try it →
Responses
DELETE/api/features/reports/{id}Delete features reports by ID
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/features/reports/{id}Create or update features reports by ID
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 4
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
enabled | body | JSON request field |
frequency | body | JSON request field |
email | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/features/reports/{id}/runCreate or update features reports by ID run
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/features/utm-presetsGet features utm presets
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/features/utm-presetsCreate or update features utm presets
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
name | body | JSON request field |
Examples in 22 languages and Try it →
Responses
DELETE/api/features/utm-presets/{id}Delete features utm presets by ID
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/features/utm-presets/{id}Create or update features utm presets by ID
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
used | body | JSON request field |
name | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/features/viewsGet features views
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/features/viewsCreate or update features views
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
name | body | JSON request field |
filters | body | JSON request field |
isDefault | body | JSON request field |
Examples in 22 languages and Try it →
Responses
DELETE/api/features/views/{id}Delete features views by ID
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/features/views/{id}Create or update features views by ID
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 4
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
name | body | JSON request field |
filters | body | JSON request field |
isDefault | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/integrations===================================================================== Hub API (signed in, org-scoped) =====================================================================
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
DELETE/api/integrations/{provider}Delete integrations :provider
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
provider | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/integrations/{provider}/choicesThe generic "pick something at the provider" pair, one dialog in the dashboard for every provider that has a choice to make. The older /options and /select above stay for the three that predate it.
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
provider | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/integrations/{provider}/chooseCreate or update integrations :provider choose
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
provider | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/integrations/{provider}/connectKey-based connect: paste fields, or mint a scoped API key.
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
provider | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
DELETE/api/integrations/{provider}/connections/{id}Disconnect: revoke at the provider where possible, forget everything here.
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
provider | path | Required path parameter |
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/integrations/{provider}/deliveriesGet integrations :provider deliveries
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
provider | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/integrations/{provider}/email-draftCreate or update integrations :provider email draft
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
provider | path | Required path parameter |
linkId | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/integrations/{provider}/importCreate or update integrations :provider import
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 5
| Name | In | Description |
|---|---|---|
provider | path | Required path parameter |
connectionId | body | JSON request field |
token | body | JSON request field |
ids | body | JSON request field |
domainId | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/integrations/{provider}/optionsThings to pick from at the provider: repositories, databases, properties.
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
provider | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/integrations/{provider}/prefsChoices that are not credentials: events to send, default domain.
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 4
| Name | In | Description |
|---|---|---|
provider | path | Required path parameter |
events | body | JSON request field |
domainId | body | JSON request field |
displayName | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/integrations/{provider}/previewCreate or update integrations :provider preview
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
provider | path | Required path parameter |
connectionId | body | JSON request field |
cursor | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/integrations/{provider}/recipeGet integrations :provider recipe
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
provider | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/integrations/{provider}/selectCommit a choice: install the GitHub hook, bind a Notion database, point a domain at a GA4 property.
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
provider | path | Required path parameter |
databaseId | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/integrations/{provider}/testA real call to the destination, with the answer.
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
provider | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/integrations/email-linksGet integrations email links
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
q | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
POST/api/integrations/google/sheet===================================================================== Google Sheets for Bulk Sheets ===================================================================== Create the spreadsheet for a bulk mode on a domain
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
mode | body | JSON request field |
domainId | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/integrations/google/sheet/rowsThe rows a customer typed into the spreadsheet, ready for /api/bulk/sheet/apply.
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
mode | query | Optional query parameter |
domainId | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
POST/api/integrations/slack/command=================================================================== INTEGRATIONS =================================================================== The hub lives in src/routes/integrations.js. The legacy unsigned Slack
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/keys=================================================================== API KEYS ===================================================================
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/keysCreate or update keys
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 5
| Name | In | Description |
|---|---|---|
kind | body | JSON request field |
scope | body | JSON request field |
scopeId | body | JSON request field |
description | body | JSON request field |
expiresAt | body | JSON request field |
Examples in 22 languages and Try it →
Responses
DELETE/api/keys/{id}Delete keys by ID
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/link-approvalsGet link approvals
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/link-approvals/{id}/decisionCreate or update link approvals by ID decision
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
decision | body | JSON request field |
note | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/link-tools/{tool}Get link tools :tool
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
tool | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/link-tools/summaryRoutes
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/link-tools/tags/mergeMerging tags is the one fix offered here, so it is the one write: every link carrying a spelling variant gets the canonical tag instead, duplicates folded.
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
to | body | JSON request field |
from | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/link-trashGet link trash
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
DELETE/api/link-trash/{id}Delete link trash by ID
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/link-trash/{id}/restoreCreate or update link trash by ID restore
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/makeGet make
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/monitor/alertsGet monitor alerts
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
state | query | Optional query parameter |
limit | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
POST/api/monitor/alerts/{id}/ackCreate or update monitor alerts by ID ack
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/monitor/alerts/ack-allCreate or update monitor alerts ack all
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/monitor/alerts/rulesGet monitor alerts rules
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/monitor/alerts/rulesCreate or update monitor alerts rules
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/monitor/alerts/testSend a test alert through every configured channel and report what each did.
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/monitor/domains/{id}===================================================================== Domain monitors =====================================================================
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
monitorAll | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/monitor/domains/{id}/checkCreate or update monitor domains by ID check
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/monitor/domains/{id}/status-pagestatus page
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
enabled | body | JSON request field |
rotate | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/monitor/insights===================================================================== Insights for the statistics page =====================================================================
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 5
| Name | In | Description |
|---|---|---|
domain_id | query | Optional query parameter |
domainId | query | Optional query parameter |
link_id | query | Optional query parameter |
linkId | query | Optional query parameter |
offenders | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
GET/api/monitor/insights/utm-offendersGet monitor insights utm offenders
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
domain_id | query | Optional query parameter |
domainId | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
POST/api/monitor/links/{id}===================================================================== Link monitors =====================================================================
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
enabled | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/monitor/links/{id}/checkCreate or update monitor links by ID check
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/monitor/links/{id}/historyGet monitor links by ID history
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/monitor/live===================================================================== Live ticker =====================================================================
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
domain_id | query | Optional query parameter |
domainId | query | Optional query parameter |
since | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
GET/api/monitor/notifications===================================================================== Notifications (the bell) =====================================================================
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/monitor/notifications/readCreate or update monitor notifications read
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
ids | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/monitor/overview===================================================================== Overview =====================================================================
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
domain_id | query | Optional query parameter |
domainId | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
POST/api/monitor/runRun every due check for this organisation now, without waiting for the scheduler.
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/onelinksCreate or update onelinks
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 6
| Name | In | Description |
|---|---|---|
domainId | body | JSON request field |
fallback | body | JSON request field |
ios | body | JSON request field |
android | body | JSON request field |
path | body | JSON request field |
title | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/openapi.jsonOpenAPI specification
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/page-templatesGet page templates
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/pagesGet pages
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/pagesCreate or update pages
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
status | body | JSON request field |
Examples in 22 languages and Try it →
Responses
DELETE/api/pages/{id}Delete pages by ID
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/pages/{id}Create or update pages by ID
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
status | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/pages/{id}/contactsGet pages by ID contacts
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
DELETE/api/pages/{id}/contacts/{contact}Delete pages by ID contacts :contact
Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
contact | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/pages/domain-accessGet pages domain access
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/pages/domain-trialCreate or update pages domain trial
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/pages/previewCreate or update pages preview
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/purchased-domainsGet purchased domains
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/purchased-domains/{id}/auto-renewCreate or update purchased domains by ID auto renew
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/site-searchGet site search
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
q | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
GET/api/support/attachments/{id}Attachment download
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/support/metaMeta — everything the new-ticket form needs to draw itself
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/support/ticketsList
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 4
| Name | In | Description |
|---|---|---|
status | query | Optional query parameter |
q | query | Optional query parameter |
limit | query | Optional query parameter |
offset | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
POST/api/support/ticketsOpen a ticket
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 5
| Name | In | Description |
|---|---|---|
subject | body | JSON request field |
message | body | JSON request field |
category | body | JSON request field |
domainId | body | JSON request field |
linkId | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/support/tickets/{id}One ticket, with its thread
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/support/tickets/{id}/ai-confirmationCreate or update support tickets by ID ai confirmation
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
resolved | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/support/tickets/{id}/closeCreate or update support tickets by ID close
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/support/tickets/{id}/rateRating
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
rating | body | JSON request field |
comment | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/support/tickets/{id}/reopenCreate or update support tickets by ID reopen
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
POST/api/support/tickets/{id}/replyReply
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
message | body | JSON request field |
body | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/upload=================================================================== Uploads (logos, covers, favicons, QR logos) ===================================================================
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
prefix | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/zapierZapier / Make discovery endpoints
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →