Skip to main content
GET
Get a website's publish status

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

appId
string
required

Query Parameters

companyId
string
required

Company ID.

Response

Publish state

publishStatus
string

idle (no publish running; the last one finished), queued, building, or failed. Poll until it is idle or failed.

publishedBuildId
string

Build currently served, or null if never published

publishedAt
string

When the served build went live (ISO 8601)

lastPublishError
string

Why the last publish failed, if it did

publishedUrl
string

The site's public URL (its custom domain when one is attached)