API reference

get/sites

List sites Every site you can see (a token limited to one team sees that team's sites only).

Token: read or deployAny team rolelistSites

Parameters

Responses

• 200 The sites, by name

  application/json · array of Site

• 401 No valid API token or session
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

post/sites

Create a site Creates an empty site. It is served at https://<name>.liftpad.ca once a deploy is published. Give team when you belong to several teams.

Token: deployDeveloper, Admin or OwnercreateSite

Request body

application/json · object

Responses

• 201 Created

  application/json · object

  Field	Type	Description
  id required	string
  name required	string
  team required	string
  url required	string

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 402 A plan limit or billing problem (error: plan_limit, credits, billing)
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 409 Conflicts with the current state (see error)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X POST "https://api.liftpad.app/v1/sites" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN" \
  -H "content-type: application/json" \
  -d '{"name":"my-site","team":"my-agency"}'

get/sites/{name}

Get a site

Token: read or deployAny team rolegetSite

Parameters

Responses

• 200 The site

  application/json · SiteDetail

  Field	Type	Description
  id required	string	Site id
  name required	string	Site name: 3 to 40 characters, a-z, 0-9 and single hyphens
  team_id	string or null	Id of the team that owns the site
  primary_domain	string or null	The custom domain visitors are sent to, or null for the liftpad.ca address
  live_deploy_id	string or null	The deploy visitors see now, or null when nothing is published
  created_at	integer	When the site was created (milliseconds since 1970, UTC)
  updated_at	integer	Last change (milliseconds since 1970, UTC)
  suspended_at	integer or null	When Liftpad suspended the site (milliseconds since 1970, UTC), or null
  functions	array of string or null	Names of the site's functions, or null
  access	string or null: all, previews, null	Visitor password scope (all or previews), or null when there is none
  url required	string (uri)	The site's address on liftpad.ca
  live	LiveRecord or null	The live pointer, or null
  domains required	array of object	Custom domains connected to the site Field Type Description hostname string created_at integer

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

delete/sites/{name}

Delete a site Takes the site offline for good, releases its domains and frees its name. Send the site's name as confirm.

Dashboard session onlyOwnerdeleteSite

Parameters

Request body

application/json · object

Responses

• 200 Deleted

  application/json · Ok

  Field	Type	Description
  ok required	true

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 409 Conflicts with the current state (see error)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)
• 502 An outside service (Cloudflare, the registrar, Stripe) did not answer; try again

Example

# Dashboard session only: an API token gets 403 forbidden
curl -sS -X DELETE "https://api.liftpad.app/v1/sites/my-site" \
  -H "content-type: application/json" \
  -d '{"confirm":"my-site"}'

post/sites/{name}/transfer

Move a site to another team For an owner of both teams. Files, deploys and domains move with the site, within the receiving team's plan.

Dashboard session onlyOwnertransferSite

Parameters

Request body

application/json · object

Responses

• 200 Moved

  application/json · object

  Field	Type	Description
  ok required	boolean
  site required	string
  team required	string

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 402 A plan limit or billing problem (error: plan_limit, credits, billing)
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 409 Conflicts with the current state (see error)
• 413 Too large for the plan or the limits
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 forbidden
curl -sS -X POST "https://api.liftpad.app/v1/sites/my-site/transfer" \
  -H "content-type: application/json" \
  -d '{"team":"client-team"}'

get/overview

Sites with health and last publish

Token: read or deployAny team rolegetOverview

Parameters

Responses

• 200 Overview

  application/json · Overview

  Field	Type	Description
  platform required	string	The dashboard domain
  sites required	array of object	Field Type Description id string Site id name required string Site name: 3 to 40 characters, a-z, 0-9 and single hyphens team_id string or null Id of the team that owns the site primary_domain string or null The custom domain visitors are sent to, or null for the liftpad.ca address live_deploy_id string or null The deploy visitors see now, or null when nothing is published created_at integer When the site was created (milliseconds since 1970, UTC) updated_at integer Last change (milliseconds since 1970, UTC) suspended_at integer or null When Liftpad suspended the site (milliseconds since 1970, UTC), or null functions array of string or null Names of the site's functions, or null access string or null: all, previews, null Visitor password scope (all or previews), or null when there is none url required string (uri) The site's address on liftpad.ca team_slug string or null team_name string or null health_ok integer or null 1 when the last health check passed, 0 when it failed, null before the first one health_detail object or null Details of the last health check health_at integer or null Last health check (milliseconds since 1970, UTC), or null deploy_count integer live_title string or null Message of the live deploy live_published_at integer or null When the live deploy was published (milliseconds since 1970, UTC), or null live_files integer or null Files in the live deploy domain_count integer platformUrl string The liftpad.ca address (url is the primary domain when there is one)

• 401 No valid API token or session
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/overview" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

get/sites/{name}/manifest

Get a deploy's manifest Every file path with its SHA-256, size and type, plus the deploy's rules. Used by exports and by deploy_changes.

Token: deployDeveloper, Admin or OwnergetManifest

Parameters

Responses

• 200 The manifest

  application/json · Manifest

  Field	Type	Description
  v required	integer
  id required	string	Deploy id
  siteId	string
  createdAt	integer
  files required	map of tuple	Path to [sha256, size, content type]
  redirects required	array of object	Redirect rules in the order they apply
  headers required	array of object	Header rules
  forms	map of object	Forms found in the pages

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/manifest" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

get/sites/{name}/files/{hash}

Download one file of a deploy Same right as the manifest: the files include the site's rules (Basic-Auth passwords) and protected pages. Always sent as a download.

Token: deployDeveloper, Admin or OwnergetSiteFile

Parameters

Responses

• 200 The file's bytes

  application/octet-stream · string (binary)

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/files/SHA256" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

get/sites/{name}/functions

Get the site's functions Functions are in alpha: only Liftpad operators can deploy them for now.

Token: read or deployAny team rolegetFunctions

Parameters

Responses

• 200 Functions, or null

  application/json · Functions or null

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/functions" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

post/sites/{name}/deploys

Start a deploy Send every file path with the SHA-256 of its bytes. The answer lists the hashes Liftpad does not have yet: upload only those, then finalize. Files your team already uploaded are reused.

Token: deployDeveloper, Admin or OwnercreateDeploy

Parameters

Request body

application/json · object

Responses

• 201 Deploy started

  application/json · object

  Field	Type	Description
  id required	string
  required required	array of string	Hashes to upload
  previewUrl required	string

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 402 A plan limit or billing problem (error: plan_limit, credits, billing)
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 413 Too large for the plan or the limits
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X POST "https://api.liftpad.app/v1/sites/my-site/deploys" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN" \
  -H "content-type: application/json" \
  -d '{"files":{"/index.html":"3a1f0c8e5b0d2d8f9c4e1a7b6d5c4b3a2f1e0d9c8b7a6f5e4d3c2b1a0f9e8d7c","/style.css":"9f8e7d6c5b4a39281706f5e4d3c2b1a0f9e8d7c6b5a493827160f5e4d3c2b1a0"},"title":"First deploy"}'

get/sites/{name}/deploys

List a site's deploys The newest 100.

Token: read or deployAny team rolelistDeploys

Parameters

Responses

• 200 Deploys, newest first

  application/json · array of DeployListItem

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/deploys" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

put/deploys/{id}/blobs/{hash}

Upload one file The raw bytes of one file the deploy asked for, with Content-Length. Liftpad checks the bytes against the hash. Up to 100 MB per file.

Token: deployDeveloper, Admin or OwneruploadDeployFile

Parameters

Request body

application/octet-stream · string (binary)

Responses

• 200 Stored

  application/json · object

  Field	Type	Description
  ok required	boolean
  hash required	string
  size required	integer

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 409 Conflicts with the current state (see error)
• 411 Content-Length header required
• 413 Too large for the plan or the limits
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X PUT "https://api.liftpad.app/v1/deploys/ID/blobs/SHA256" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN" \
  -H "content-type: application/octet-stream" \
  --data-binary @public/index.html

post/deploys/{id}/finalize

Finish a deploy Reads the rules and forms, runs the launch checks and makes the preview address work. If files are missing the answer is 409 missing_blobs with the hashes to upload; upload them and call again. Calling it on a ready deploy answers ready again.

Token: deployDeveloper, Admin or OwnerfinalizeDeploy

Parameters

Responses

• 200 Ready

  application/json · object

  Field	Type	Description
  id required	string
  state required	"ready"
  previewUrl	string
  summary	DeploySummary
  held	boolean	Held for a Liftpad safety review
  message	string

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 404 Not found, or not visible to you
• 409 Conflicts with the current state (see error)
• 413 Too large for the plan or the limits
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X POST "https://api.liftpad.app/v1/deploys/ID/finalize" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

get/deploys/{id}

Get a deploy

Token: read or deployAny team rolegetDeploy

Parameters

Responses

• 200 The deploy

  application/json · Deploy

  Field	Type	Description
  id required	string	Deploy id
  site_id	string
  site_name	string
  team_id	string or null
  state required	string: uploading, ready, expired	uploading until finalized, then ready
  title	string or null	The deploy message
  file_count	integer
  total_size	integer	Bytes
  created_at	integer	Started (milliseconds since 1970, UTC)
  ready_at	integer or null	Finalized (milliseconds since 1970, UTC), or null
  published_at	integer or null	Last published (milliseconds since 1970, UTC), or null
  held required	boolean	True while a Liftpad safety review holds it (it cannot be published)
  required required	array of string	Files still to upload (while uploading)
  summary	object or null	Set once ready

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/deploys/ID" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

get/deploys/{id}/checks

Launch checks of a deploy Broken links, missing files, titles, descriptions, alt text, insecure content, heavy images, sitemap, robots.txt and more, read from up to 400 pages.

Token: read or deployAny team rolegetDeployChecks

Parameters

Responses

• 200 The report

  application/json · CheckReport

  Field	Type	Description
  v	integer
  score required	integer	0 to 100
  pages required	integer	HTML pages read
  counts required	object	Number of issues per level Field Type Description error integer warning integer info integer
  issues required	array of object	Field Type Description level required string: error, warning, info code required string Stable code, for example broken_link or missing_alt page required string or null The page, or null for the whole site detail required string ref string The file the issue is about, when there is one
  truncated	boolean	True when the list was cut short

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/deploys/ID/checks" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

post/deploys/{id}/suggest

AI title and description for a page Written from the page's own text. Uses the plan's monthly AI suggestions; the same page content is answered from cache for free.

Token: deployDeveloper, Admin or OwnersuggestPageMeta

Parameters

Request body

application/json · object

Responses

• 200 Suggestion

  application/json · object

  Field	Type	Description
  title required	string
  description required	string
  cached required	boolean
  left	integer	Suggestions left this month

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 404 Not found, or not visible to you
• 422 The AI found no safe answer this time
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X POST "https://api.liftpad.app/v1/deploys/ID/suggest" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN" \
  -H "content-type: application/json" \
  -d '{"page":"/about.html"}'

post/deploys/{id}/alt

AI alt text for an image A vision model describes one image of the deploy in one sentence, in the page's language.

Token: deployDeveloper, Admin or OwnersuggestImageAlt

Parameters

Request body

application/json · object

Responses

• 200 Alt text

  application/json · object

  Field	Type	Description
  alt required	string
  lang	string
  src	string
  cached required	boolean

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 404 Not found, or not visible to you
• 422 The AI found no safe answer this time
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X POST "https://api.liftpad.app/v1/deploys/ID/alt" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN" \
  -H "content-type: application/json" \
  -d '{"page":"/index.html","src":"img/team.jpg"}'

post/sites/{name}/publish

Publish a deploy (or roll back) Makes a ready deploy live everywhere within about 5 seconds. Publishing an older deploy is a rollback. Ends a running split test.

Token: deployDeveloper, Admin or OwnerpublishDeploy

Parameters

Request body

application/json · object

Responses

• 200 Live

  application/json · object

  Field	Type	Description
  site required	string
  deployId required	string
  generation required	integer
  url required	string	The live address (primary domain when there is one)

• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 409 Conflicts with the current state (see error)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)
• 503 Not available yet on this Liftpad, or for a moment

Example

curl -sS -X POST "https://api.liftpad.app/v1/sites/my-site/publish" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN" \
  -H "content-type: application/json" \
  -d '{"deployId":"k2j4h6g8f0d2"}'

post/sites/{name}/unpublish

Take a site offline Nothing is deleted: publish a deploy again to bring it back.

Token: deployDeveloper, Admin or OwnerunpublishSite

Parameters

Responses

• 200 Offline

  application/json · Ok

  Field	Type	Description
  ok required	true

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X POST "https://api.liftpad.app/v1/sites/my-site/unpublish" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

post/sites/{name}/domains

Connect a domain you own Answers with the DNS records to add. HTTPS starts once DNS points at Liftpad. With primary, the domain becomes the main address as soon as it is ready.

Token: deployDeveloper, Admin or OwneraddDomain

Parameters

Request body

application/json · object

Responses

• 201 Added

  application/json · object

  Field	Type	Description
  hostname required	string
  site	string
  primary	boolean
  mainWhenReady	boolean
  status required	string
  sslStatus	string
  records required	array of object

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 402 A plan limit or billing problem (error: plan_limit, credits, billing)
• 404 Not found, or not visible to you
• 409 Conflicts with the current state (see error)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)
• 502 An outside service (Cloudflare, the registrar, Stripe) did not answer; try again

Example

curl -sS -X POST "https://api.liftpad.app/v1/sites/my-site/domains" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN" \
  -H "content-type: application/json" \
  -d '{"hostname":"www.example.com","primary":true}'

get/sites/{name}/domains

List a site's domains With fresh DNS and certificate status (checked at most once a minute).

Token: read or deployAny team rolelistDomains

Parameters

Responses

• 200 Domains

  application/json · array of Domain

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/domains" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

delete/sites/{name}/domains/{hostname}

Remove a domain A domain bought on Liftpad stays connected while it is registered.

Token: deployDeveloper, Admin or OwnerremoveDomain

Parameters

Responses

• 200 Removed

  application/json · Ok

  Field	Type	Description
  ok required	true

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 409 Conflicts with the current state (see error)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)
• 502 An outside service (Cloudflare, the registrar, Stripe) did not answer; try again

Example

curl -sS -X DELETE "https://api.liftpad.app/v1/sites/my-site/domains/www.example.com" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

post/sites/{name}/primary

Choose the main address Visitors on other addresses are sent to the main one. null goes back to the liftpad.ca address. A domain that is not ready yet becomes the main one automatically when it is (409 domain_not_ready).

Token: deployDeveloper, Admin or OwnersetPrimaryDomain

Parameters

Request body

application/json · object

Responses

• 200 Set

  application/json · object

  Field	Type	Description
  ok required	boolean
  primary required	string or null

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 404 Not found, or not visible to you
• 409 Conflicts with the current state (see error)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X POST "https://api.liftpad.app/v1/sites/my-site/primary" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN" \
  -H "content-type: application/json" \
  -d '{"hostname":"www.example.com"}'

get/domains/search

Search domain names Is a name free, and its price in CAD. No sign-in needed. Answers for the same names are cached for ten minutes.

No sign-insearchDomains

Parameters

Responses

• 200 Results

  application/json · DomainSearch

  Field	Type	Description
  query required	string
  exact	string or null	The full name asked for, when the query was one
  currency	"CAD"
  results required	array of object	Field Type Description name required string available required boolean priceCad number First year, CAD, taxes extra renewCad number Each later year, CAD includable boolean Covered by the Business plan's included domain reason string Why a name cannot be had

• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)
• 502 An outside service (Cloudflare, the registrar, Stripe) did not answer; try again
• 503 Not available yet on this Liftpad, or for a moment

Example

curl -sS "https://api.liftpad.app/v1/domains/search?q=boulangerie"

get/sites/{name}/domain-orders

Domain orders of a site

Token: read or deployAny team rolelistDomainOrders

Parameters

Responses

• 200 Orders

  application/json · object

  Field	Type	Description
  orders required	array of DomainOrder
  includedLeft	integer	Included domains left this year
  includedPlan	boolean
  ready	boolean	Domain sales are open
  payments	boolean	Online payment is open

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/domain-orders" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

post/sites/{name}/domains/buy

Buy a domain for a site Owners and admins, from the dashboard. Uses the plan's included domain when it covers the name; otherwise answers with a Stripe checkout address, or sends the request to Liftpad when online payment is not open.

Dashboard session onlyAdmin or OwnerbuyDomain

Parameters

Request body

application/json · object

Responses

• 201 Ordered

  application/json · object

  Field	Type	Description
  order required	DomainOrder
  checkoutUrl	string	Stripe payment page, when payment is needed

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 402 A plan limit or billing problem (error: plan_limit, credits, billing)
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 409 Conflicts with the current state (see error)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)
• 502 An outside service (Cloudflare, the registrar, Stripe) did not answer; try again
• 503 Not available yet on this Liftpad, or for a moment

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X POST "https://api.liftpad.app/v1/sites/my-site/domains/buy" \
  -H "content-type: application/json" \
  -d '{"domain":"yourbusiness.ca"}'

get/sites/{name}/forms

List forms Forms of the live deploy, with how many submissions each has received.

Token: read or deployAny team rolelistForms

Parameters

Responses

• 200 Forms

  application/json · object

  Field	Type	Description
  allowance	integer or null	Submissions per month on the plan
  forms required	array of Form

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/forms" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

get/sites/{name}/submissions

List form submissions Newest first. Pass next as before to get the following page.

Token: read or deployAny team rolelistSubmissions

Parameters

Responses

• 200 A page of submissions

  application/json · object

  Field	Type	Description
  submissions required	array of Submission
  next required	integer or null	Value for before, or null at the end

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/submissions" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

get/sites/{name}/forms/{form}/submissions.csv

Download submissions as CSV Every submission of one form, safe to open in a spreadsheet (values that would run as formulas are quoted). Up to 50 000 rows.

Token: read or deployAny team roleexportSubmissionsCsv

Parameters

Responses

• 200 CSV file

  text/csv · string

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/forms/contact/submissions.csv" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

get/sites/{name}/submissions/{id}/files/{i}

Download a file sent with a submission Always sent as a download, never shown in the browser (it came from a visitor).

Token: read or deployAny team rolegetSubmissionFile

Parameters

Responses

• 200 The file

  application/octet-stream · string (binary)

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/submissions/ID/files/0" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

patch/sites/{name}/submissions/{id}

Mark as spam or not spam

Token: deployDeveloper, Admin or OwnermarkSubmission

Parameters

Request body

application/json · object

Responses

• 200 Saved

  application/json · Ok

  Field	Type	Description
  ok required	true

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X PATCH "https://api.liftpad.app/v1/sites/my-site/submissions/ID" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN" \
  -H "content-type: application/json" \
  -d '{"spam":true}'

delete/sites/{name}/submissions/{id}

Delete a submission Its files are deleted too.

Token: deployDeveloper, Admin or OwnerdeleteSubmission

Parameters

Responses

• 200 Deleted

  application/json · Ok

  Field	Type	Description
  ok required	true

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X DELETE "https://api.liftpad.app/v1/sites/my-site/submissions/ID" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

post/sites/{name}/submissions/import

Import submissions from another host Up to 500 per call. Dates are kept, nobody is emailed and files are not copied. Sending the same id twice imports it once.

Token: deployDeveloper, Admin or OwnerimportSubmissions

Parameters

Request body

application/json · object

Responses

• 200 Imported

  application/json · object

  Field	Type	Description
  ok required	boolean
  imported required	integer
  skipped required	integer

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X POST "https://api.liftpad.app/v1/sites/my-site/submissions/import" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN" \
  -H "content-type: application/json" \
  -d '{"submissions":[{"id":"abc123","form":"contact","data":{"name":"Sam","message":"Hello"},"createdAt":1767225600000}]}'

get/sites/{name}/snippets

Get code snippets

Token: read or deployAny team rolegetSnippets

Parameters

Responses

• 200 Snippets

  application/json · array of Snippet

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/snippets" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

put/sites/{name}/snippets

Replace code snippets The whole list: up to 10 snippets, 20 000 characters each, 50 000 in all, added to every HTML page without a deploy. Paid plans only.

Token: deployDeveloper, Admin or OwnersetSnippets

Parameters

Request body

application/json · object

Responses

• 200 The saved list

  application/json · array of Snippet

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 402 A plan limit or billing problem (error: plan_limit, credits, billing)
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X PUT "https://api.liftpad.app/v1/sites/my-site/snippets" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN" \
  -H "content-type: application/json" \
  -d '{"snippets":[{"name":"Analytics","where":"head","html":"<script defer src=\"https://example.com/a.js\"></script>"}]}'

get/sites/{name}/split

Get the split test

Token: read or deployAny team rolegetSplitTest

Parameters

Responses

• 200 The test, or null

  application/json · SplitTest or null

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/split" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

put/sites/{name}/split

Start, change or stop a split test A share of the live site's visitors (1 to 99 %) sees another ready deploy. Send deployId null to stop.

Token: deployDeveloper, Admin or OwnersetSplitTest

Parameters

Request body

application/json · object

Responses

• 200 The test, or null

  application/json · SplitTest or null

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 409 Conflicts with the current state (see error)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X PUT "https://api.liftpad.app/v1/sites/my-site/split" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN" \
  -H "content-type: application/json" \
  -d '{"deployId":"k2j4h6g8f0d2","percent":20}'

get/sites/{name}/access

Visitor password status

Token: read or deployAny team rolegetVisitorAccess

Parameters

Responses

• 200 Status

  application/json · object

  Field	Type	Description
  enabled required	boolean
  scope required	string or null: all, previews, null
  updatedAt	integer or null

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/access" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

put/sites/{name}/access

Set or remove the visitor password A password page in front of the whole site or only its previews. password null removes it. Changing it signs every visitor out. Not possible with an API token.

Dashboard session onlyDeveloper, Admin or OwnersetVisitorAccess

Parameters

Request body

application/json · object

Responses

• 200 Saved

  application/json · object

  Field	Type	Description
  ok required	boolean
  enabled required	boolean
  scope	string or null

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X PUT "https://api.liftpad.app/v1/sites/my-site/access" \
  -H "content-type: application/json" \
  -d '{"password":"a long shared password","scope":"previews"}'

get/sites/{name}/hooks

List notifications Webhooks and Slack messages of a site. Dashboard session only.

Dashboard session onlyDeveloper, Admin or OwnerlistHooks

Parameters

Responses

• 200 Notifications

  application/json · array of Hook

• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS "https://api.liftpad.app/v1/sites/my-site/hooks"

post/sites/{name}/hooks

Add a notification A signed webhook or a Slack incoming webhook for some of: deploy.ready, deploy.published, form.submission. Public https addresses only, never Liftpad or a site it hosts. Up to 10 per site. A webhook's signing secret is in this answer only.

Dashboard session onlyDeveloper, Admin or OwnercreateHook

Parameters

Request body

application/json · object

Responses

• 201 Added

  application/json · object

  Field	Type	Description
  id required	string
  kind required	string: webhook, slack
  url required	string	Where events are sent (Slack addresses are shown shortened)
  events required	array of string: deploy.ready, deploy.published, form.submission
  createdAt	integer
  lastStatus	integer or null	HTTP status of the last delivery (0 when it could not connect)
  lastAt	integer or null
  paused	boolean	True after 50 failed deliveries in a row
  secret	string	Signing secret (lpwh_...), shown once

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X POST "https://api.liftpad.app/v1/sites/my-site/hooks" \
  -H "content-type: application/json" \
  -d '{"kind":"webhook","url":"https://example.com/liftpad","events":["deploy.published","form.submission"]}'

post/sites/{name}/hooks/{id}/test

Send a test notification

Dashboard session onlyDeveloper, Admin or OwnertestHook

Parameters

Responses

• 200 How the delivery went

  application/json · object

  Field	Type	Description
  status required	integer	HTTP status of the receiver (0 when it could not connect)
  ok required	boolean

• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X POST "https://api.liftpad.app/v1/sites/my-site/hooks/ID/test"

delete/sites/{name}/hooks/{id}

Remove a notification

Dashboard session onlyDeveloper, Admin or OwnerdeleteHook

Parameters

Responses

• 200 Removed

  application/json · Ok

  Field	Type	Description
  ok required	true

• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X DELETE "https://api.liftpad.app/v1/sites/my-site/hooks/ID"

get/sites/{name}/analytics

Visitor statistics

Token: read or deployAny team rolegetAnalytics

Parameters

Responses

• 200 Statistics

  application/json · Analytics

  Field	Type	Description
  enabled required	boolean	False when analytics are not set up on this Liftpad
  days	integer
  views	integer
  visitors	integer
  daily	array of object	Field Type Description day string views integer visitors integer
  pages	array of object	Field Type Description path string views integer

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)
• 503 Not available yet on this Liftpad, or for a moment

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/analytics" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

post/sites/{name}/ai-build

Build a site with AI Writes, illustrates and builds a complete site from a short brief, as a draft deploy. Costs 100 credits, given back if the job fails. Dashboard session only.

Dashboard session onlyDeveloper, Admin or OwneraiBuildSite

Parameters

Request body

application/json · object

Responses

• 202 Queued

  application/json · object

  Field	Type	Description
  job required	object	Field Type Description id string kind string status string credits integer

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 402 A plan limit or billing problem (error: plan_limit, credits, billing)
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X POST "https://api.liftpad.app/v1/sites/my-site/ai-build" \
  -H "content-type: application/json" \
  -d '{"name":"Boulangerie Lune","about":"A neighbourhood bakery in Montreal with sourdough and pastries.","langs":["fr","en"],"style":"warm"}'

post/sites/{name}/ai-edit

Change an AI-built site in words Costs 20 credits, plus 10 with newImages. Dashboard session only.

Dashboard session onlyDeveloper, Admin or OwneraiEditSite

Parameters

Request body

application/json · object

Responses

• 202 Queued

  application/json · object

  Field	Type	Description
  job required	object	Field Type Description id string kind string status string credits integer

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 402 A plan limit or billing problem (error: plan_limit, credits, billing)
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 409 Conflicts with the current state (see error)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X POST "https://api.liftpad.app/v1/sites/my-site/ai-edit" \
  -H "content-type: application/json" \
  -d '{"instruction":"Add our Sunday hours: 9 to 2."}'

get/sites/{name}/ai

AI jobs of a site

Token: read or deployAny team rolegetAiJobs

Parameters

Responses

• 200 Jobs

  application/json · object

  Field	Type	Description
  aiSite required	boolean	Built with the AI builder
  jobs required	array of AiJob
  costs required	map of integer
  credits	object or null	Shown to owners, admins, billing and developers

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/sites/my-site/ai" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

get/me

Who am I The caller, their teams and roles. With a token, roles are what the token may do.

Token: read or deployAny team rolegetMe

Responses

• 200 You

  application/json · Me

  Field	Type	Description
  kind required	string: session, token	How the caller signed in
  user required	object	Field Type Description id string email required string name string or null totp_enabled integer created_at integer last_login_at integer or null recovery_left integer
  platformAdmin	boolean
  teams required	array of Team
  roles	array of object	Field Type Description id string label string

• 401 No valid API token or session
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/me" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

patch/me

Change your name

Dashboard session onlyupdateMe

Request body

application/json · object

Responses

• 200 Saved

  application/json · Ok

  Field	Type	Description
  ok required	true

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X PATCH "https://api.liftpad.app/v1/me" \
  -H "content-type: application/json" \
  -d '{"name":"Sam Tremblay"}'

post/me/logout-all

Sign out everywhere Ends every session and cancels every API token you made.

Dashboard session onlylogoutEverywhere

Responses

• 200 Signed out

  application/json · Ok

  Field	Type	Description
  ok required	true

• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X POST "https://api.liftpad.app/v1/me/logout-all"

get/me/tokens

List your API tokens Names and dates only; a token's value is never shown again.

Token: read or deploylistTokens

Responses

• 200 Tokens

  application/json · array of Token

• 401 No valid API token or session
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/me/tokens" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

post/me/tokens

Create an API token Dashboard session only (a token cannot make tokens). access is deploy (sites, deploys, domains) or read. team limits it to one team. days sets the expiry (the dashboard offers 90, 365 or none; at most 730). The token is in this answer only.

Dashboard session onlycreateToken

Request body

application/json · object

Responses

• 201 Created

  application/json · object

  Field	Type	Description
  id required	string
  token required	string	lp_... shown once
  expiresAt required	integer or null

• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X POST "https://api.liftpad.app/v1/me/tokens" \
  -H "content-type: application/json" \
  -d '{"name":"GitHub Actions","access":"deploy","team":"my-agency","days":90}'

delete/me/tokens/{id}

Revoke an API token

Dashboard session onlyrevokeToken

Parameters

Responses

• 200 Revoked

  application/json · Ok

  Field	Type	Description
  ok required	true

• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X DELETE "https://api.liftpad.app/v1/me/tokens/ID"

get/teams

List your teams

Token: read or deployAny team rolelistTeams

Responses

• 200 Teams

  application/json · array of Team

• 401 No valid API token or session
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/teams" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

get/teams/{slug}

Get a team With members and pending invites (invites for those who manage members).

Token: read or deployAny team rolegetTeam

Parameters

Responses

• 200 The team

  application/json · object

  Field	Type	Description
  id	string
  slug required	string
  name	string
  role	string: owner, admin, developer, reviewer, billing, viewer	Your role in the team (for a token: what the token may do)
  caps	array of string: view, deploy, sites, domains, members, billing, team
  scoped	boolean	You see only some of the team's sites
  plan	Plan
  billingStatus	string or null
  billing	object or null
  trialEndsAt	integer or null
  currentPeriodEnd	integer or null
  billingEmail	string or null
  usage	object or null	Sites, domains, members and storage used
  members required	array of object
  invites	array of object
  roles	array of object

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/teams/my-agency" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

patch/teams/{slug}

Rename a team or change its billing email name needs an owner; billingEmail needs an owner or a billing member.

Dashboard session onlyOwnerupdateTeam

Parameters

Request body

application/json · object

Responses

• 200 Saved

  application/json · Ok

  Field	Type	Description
  ok required	true

• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X PATCH "https://api.liftpad.app/v1/teams/my-agency" \
  -H "content-type: application/json" \
  -d '{"name":"My Agency"}'

post/teams/{slug}/invites

Invite someone A one-time link by email. sites limits a Developer, Reviewer or Team viewer to some sites. Only owners invite owners or billing members.

Dashboard session onlyAdmin or OwnerinviteMember

Parameters

Request body

application/json · object

Responses

• 201 Invited

  application/json · object

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X POST "https://api.liftpad.app/v1/teams/my-agency/invites" \
  -H "content-type: application/json" \
  -d '{"email":"client@example.com","role":"reviewer","sites":["client-site"]}'

delete/teams/{slug}/invites/{id}

Cancel an invite

Dashboard session onlyAdmin or OwnerrevokeInvite

Parameters

Responses

• 200 Canceled

  application/json · Ok

  Field	Type	Description
  ok required	true

• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X DELETE "https://api.liftpad.app/v1/teams/my-agency/invites/ID"

patch/teams/{slug}/members/{userId}

Change a member's role or sites sites null removes the site limit. A team always keeps one owner.

Dashboard session onlyAdmin or OwnerupdateMember

Parameters

Request body

application/json · object

Responses

• 200 Saved

  application/json · Ok

  Field	Type	Description
  ok required	true

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X PATCH "https://api.liftpad.app/v1/teams/my-agency/members/USER_ID" \
  -H "content-type: application/json" \
  -d '{"role":"developer"}'

delete/teams/{slug}/members/{userId}

Remove a member (or leave) Their tokens for this team stop working.

Dashboard session onlyAdmin or OwnerremoveMember

Parameters

Responses

• 200 Removed

  application/json · Ok

  Field	Type	Description
  ok required	true

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X DELETE "https://api.liftpad.app/v1/teams/my-agency/members/USER_ID"

get/plans

List plans Prices in CAD per month, taxes extra. No sign-in needed.

No sign-inlistPlans

Responses

• 200 Plans

  application/json · array of Plan

Example

curl -sS "https://api.liftpad.app/v1/plans"

get/teams/{slug}/billing

A team's plan and billing

Token: read or deployAny team rolegetBilling

Parameters

Responses

• 200 Billing

  application/json · object

  Field	Type	Description
  id	string
  slug	string
  name	string
  role	string: owner, admin, developer, reviewer, billing, viewer	Your role in the team (for a token: what the token may do)
  caps	array of string: view, deploy, sites, domains, members, billing, team
  scoped	boolean	You see only some of the team's sites
  plan	Plan
  billingStatus	string or null
  billing	object or null
  trialEndsAt	integer or null
  currentPeriodEnd	integer or null
  billingEmail	string or null
  usage	object or null	Sites, domains, members and storage used
  canManage	boolean
  plans required	array of object
  portalUrl	string or null
  stripeLinked	boolean

• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/teams/my-agency/billing" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

get/teams/{slug}/credits

A team's credits Balance, costs, packs and the last 30 movements. Packs: 1000 for C$10, 5000 for C$45, 12000 for C$99.

Token: read or deployAny team rolegetCredits

Parameters

Responses

• 200 Credits

  application/json · Credits

  Field	Type	Description
  total required	integer
  monthly	integer	Left from this month's plan credits
  bought	integer
  planMonthly	integer
  costs required	map of integer	Credits per action
  packs required	array of object	Field Type Description id string credits integer priceCad number
  payments	boolean	Online payment is open
  card	object or null
  auto	object or null	Automatic top-up settings
  ledger	array of object	Field Type Description at integer delta integer kind string note string or null

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/teams/my-agency/credits" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

post/teams/{slug}/credits/checkout

Buy a credit pack Owners and billing members. Answers with a Stripe checkout address.

Dashboard session onlyOwner or BillingbuyCredits

Parameters

Request body

application/json · object

Responses

• 201 Checkout opened

  application/json · object

  Field	Type	Description
  checkoutUrl required	string

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)
• 502 An outside service (Cloudflare, the registrar, Stripe) did not answer; try again
• 503 Not available yet on this Liftpad, or for a moment

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X POST "https://api.liftpad.app/v1/teams/my-agency/credits/checkout" \
  -H "content-type: application/json" \
  -d '{"pack":"credits_1000"}'

post/teams/{slug}/credits/auto

Automatic top-ups Buys a pack when the balance falls below a line, at most 3 times a month. pack null turns it off.

Dashboard session onlyOwner or BillingsetAutoTopup

Parameters

Request body

application/json · object

Responses

• 200 Saved

  application/json · Ok

  Field	Type	Description
  ok required	true

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 409 Conflicts with the current state (see error)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X POST "https://api.liftpad.app/v1/teams/my-agency/credits/auto" \
  -H "content-type: application/json" \
  -d '{"pack":"credits_1000","below":100}'

delete/teams/{slug}/credits/card

Forget the saved card

Dashboard session onlyOwner or BillingforgetCard

Parameters

Responses

• 200 Removed

  application/json · Ok

  Field	Type	Description
  ok required	true

• 401 No valid API token or session
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

# Dashboard session only: an API token gets 403 session_required
curl -sS -X DELETE "https://api.liftpad.app/v1/teams/my-agency/credits/card"

get/audit

Activity log The last 200 actions in your teams (only your sites when you are limited to some).

Token: read or deployAny team rolelistAudit

Parameters

Responses

• 200 Entries, newest first

  application/json · array of AuditEntry

• 401 No valid API token or session
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS "https://api.liftpad.app/v1/audit" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN"

post/abuse

Report a site hosted on Liftpad Anyone can report phishing, malware, scams and other abuse. A person at Liftpad reviews every report. Needs the x-liftpad-csrf header and a JSON body.

No sign-inreportAbuse

Parameters

Request body

application/json · object

Responses

• 201 Received

  application/json · object

  Field	Type	Description
  ok required	boolean
  message	string

• 400 The request is not valid (see error and message)
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 404 Not found, or not visible to you
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X POST "https://api.liftpad.app/v1/abuse" \
  -H "x-liftpad-csrf: 1" \
  -H "content-type: application/json" \
  -d '{"url":"https://example.liftpad.ca/login","kind":"phishing","details":"Asks for bank passwords."}'

post/leads

Ask Liftpad to contact you The contact form of liftpad.app. Needs the x-liftpad-csrf header and a JSON body.

No sign-inrequestContact

Parameters

Request body

application/json · object

Responses

• 200 Received

  application/json · Ok

  Field	Type	Description
  ok required	true

• 400 The request is not valid (see error and message)
• 403 Not allowed: your role is too low, a token was used where a dashboard session is needed (session_required), or the CSRF header is missing (csrf)
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X POST "https://api.liftpad.app/v1/leads" \
  -H "x-liftpad-csrf: 1" \
  -H "content-type: application/json" \
  -d '{"name":"Sam","email":"sam@example.com","sites":"4-10","lang":"en"}'

post/mcp

MCP server for AI agents Model Context Protocol over streamable HTTP, stateless JSON-RPC 2.0 (initialize, ping, tools/list, tools/call; a batch answers its first 20 messages, and messages after the 20th are ignored with no answer). API tokens only, never a cookie. Every tool calls this API with your token, so the same roles and limits apply: a read token can use list_sites, get_site, list_deploys, launch_checks, form_submissions, site_analytics and search_domains; the others need a deploy token. Tools: list_sites, get_site, create_site, list_files, read_file, deploy_changes, launch_checks, list_deploys, publish, form_submissions, site_analytics, search_domains, connect_domain, site_agents_report.

Token: read or deployAny team rolemcp

Request body

application/json · object or array of object

Responses

• 200 JSON-RPC answer (202 with no body for notifications)

  application/json · object or array of any

• 400 The request is not valid (see error and message)
• 401 No valid API token or session
• 429 Too many requests (error: rate_limited) or a daily limit (error: deploy_limit)

Example

curl -sS -X POST "https://api.liftpad.app/mcp" \
  -H "Authorization: Bearer $LIFTPAD_TOKEN" \
  -H "content-type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"list_sites","arguments":{}}}'

get/openapi.json

This OpenAPI document Also at https://liftpad.app/openapi.json.

No sign-ingetOpenApi

Responses

• 200 OpenAPI 3.1

  application/json · object

Example

curl -sS "https://api.liftpad.app/v1/openapi.json"

postdeploy.ready

A deploy finished and its preview works

application/json · object

{
  "event": "deploy.ready",
  "delivery": "6f1c2a9e-0d4b-4c2e-9a77-3b1f0c2d4e5f",
  "at": "2026-11-05T15:04:05.000Z",
  "site": {
    "name": "my-site",
    "url": "https://my-site.liftpad.ca"
  },
  "deploy": {
    "id": "k2j4h6g8f0d2",
    "title": "First deploy",
    "previewUrl": "https://k2j4h6g8f0d2--my-site.liftpad.ca",
    "files": 12
  }
}

postdeploy.published

A deploy went live (also after a rollback)

application/json · object

{
  "event": "deploy.published",
  "delivery": "0a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "at": "2026-11-05T15:05:00.000Z",
  "site": {
    "name": "my-site",
    "url": "https://www.example.com"
  },
  "deploy": {
    "id": "k2j4h6g8f0d2",
    "title": "First deploy"
  }
}

postform.submission

A visitor sent a form (spam is not sent)

application/json · object

{
  "event": "form.submission",
  "delivery": "9e8d7c6b-5a4f-4e3d-9c2b-1a0f9e8d7c6b",
  "at": "2026-11-05T15:06:00.000Z",
  "site": {
    "name": "my-site",
    "url": "https://my-site.liftpad.ca"
  },
  "submission": {
    "id": "sub_abc123",
    "form": "contact",
    "data": {
      "name": "Sam",
      "message": "Hello"
    },
    "files": [],
    "preview": false,
    "createdAt": 1793977560000
  }
}

posttest

Sent by the test button (testHook)

application/json · object

{
  "event": "test",
  "delivery": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
  "at": "2026-11-05T15:07:00.000Z",
  "site": {
    "name": "my-site",
    "url": "https://my-site.liftpad.ca"
  }
}