Get Website Flow

GET https://api.secure.quotivity.com/v1/website/flows/{flowId}

Returns the configuration the website embed renders for a flow that is published on your website. Requires the Enterprise Website add-on. Authenticate with the flow’s website key as a bearer token and send the embedding page’s Origin; the origin must be one of the account’s allowed domains. The response is cacheable for 60 seconds. Limited to 300 requests per hour per visitor IP address and flow.

Path parameters

Name	Type	Required	Description
`flowId`	string	Yes	The flow id from the script tag’s `data-flow` attribute.

Responses

Status	Body	Description
`200`	WebsiteFlowConfig	The flow’s public configuration
`401`	WebsiteFlowError	Missing or invalid website key (`UNAUTHORIZED`)
`403`	WebsiteFlowError	The origin is not allowed (`ORIGIN_NOT_ALLOWED`), or the flow is not published or the account lacks the add-on (`UNAVAILABLE`)
`404`	WebsiteFlowError	The flow does not exist or is not active (`UNAVAILABLE`)
`429`	WebsiteFlowError	Rate limit exceeded (`RATE_LIMITED`); honour `Retry-After`

Schemas

WebsiteFlowConfig

Everything the published flow needs to run: the steps and questions (HubSpot sync details omitted, except that the contact email question keeps its contact/email sync so the page knows which answer identifies the visitor), the response page copy, the account-wide appearance and the support email.

Field	Type	Required	Description
`flow`	object	Yes	—
`questions`	object[]	Yes	The flow’s questions. Text and email questions take a string answer; an email question with `blockPublicEmailDomains` (default true) refuses public mailbox domains.
`responsePage`	object	Yes	—
`appearance`	object	Yes	—
`supportEmail`	string	No	—

WebsiteFlowError

Returned by the Website Flows operations for every non-success status. code tells the embedding page whether to retry or to show the account’s support email; reference is the id a visitor can quote to support.

Field	Type	Required	Description
`code`	`UNAUTHORIZED` \| `UNAVAILABLE` \| `ORIGIN_NOT_ALLOWED` \| `RATE_LIMITED` \| `VALIDATION` \| `SUBMIT_FAILED`	Yes	—
`message`	string	Yes	—
`reference`	string	No	Short request id for support, present on 5xx responses.
`retryAfterSeconds`	integer	No	Present with RATE_LIMITED; also sent as the Retry-After header.