Skip to main content
GET
Get a lead form

Authorizations

Authorization
string
header
required

API Key Authentication

Use your API key in the Authorization header:

Key Types:

Secret Keys (Server-Side Only):

  • Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
  • Full read/write access to all endpoints
  • ⚠️ NEVER expose in client-side code or public repositories
  • Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

  • Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
  • Catalogue reads, plus the actions a shopper takes for themselves
  • ✅ Safe for client-side JavaScript, mobile apps, and public code
  • Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist, reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents

Endpoint-Specific Requirements:

  • Authentication endpoints (/v1/auth/*): Secret key required
  • Payment verification (POST /v1/payments/verify): Secret key required
  • AI Recommendations (POST /v1/recommendations): Secret key required
  • Semantic Search (POST /v1/search): Both key types allowed (read-only operation)
  • Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
  • All other write operations: Secret key required
  • All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Path Parameters

slug
string
required

The form's address, lowercase letters, digits and hyphens, starting with a letter.

Pattern: ^[a-z][a-z0-9-]{0,62}$

Response

The form definition.

slug
string
required
Example:

"spring-lookbook"

title
string
required
Example:

"Get the spring lookbook"

submit_label
string
required
Example:

"Send it to me"

success_message
string
required
Example:

"Thanks, check your inbox."

double_opt_in
boolean
required

When true, a shopper's signup is held until they confirm it from an email.

Example:

false

fields
object[]
required

The questions beyond the email address, in display order. The email address is always collected and is not listed.

consents
object
required

The consent checkboxes the form asks for, each with the wording to display. A key is absent when the form does not ask for that consent.

captcha
object
required
hp_field
string
required

The name of a field the storefront renders hidden. A submission that fills it is acknowledged and discarded.

Example:

"website_url"

description
string | null
Example:

"Enter your email and we will send the lookbook."

redirect_url
string

Where the merchant wants the shopper sent after a successful signup. Present only when set.