Skip to content

Latest commit

 

History

History
147 lines (120 loc) · 2.88 KB

README.md

File metadata and controls

147 lines (120 loc) · 2.88 KB

Unbounce Routing Reference

App name: unbounce Base URL proxied: api.unbounce.com

API Path Pattern

/unbounce/accounts
/unbounce/accounts/{account_id}
/unbounce/accounts/{account_id}/sub_accounts
/unbounce/accounts/{account_id}/pages
/unbounce/sub_accounts/{sub_account_id}
/unbounce/sub_accounts/{sub_account_id}/pages
/unbounce/sub_accounts/{sub_account_id}/domains
/unbounce/sub_accounts/{sub_account_id}/page_groups
/unbounce/pages
/unbounce/pages/{page_id}
/unbounce/pages/{page_id}/form_fields
/unbounce/pages/{page_id}/leads
/unbounce/leads/{lead_id}
/unbounce/domains/{domain_id}
/unbounce/domains/{domain_id}/pages
/unbounce/page_groups/{page_group_id}/pages
/unbounce/users/self
/unbounce/users/{user_id}

Common Endpoints

List Accounts

GET /unbounce/accounts

Get Account

GET /unbounce/accounts/{account_id}

List Sub-Accounts

GET /unbounce/accounts/{account_id}/sub_accounts

Get Sub-Account

GET /unbounce/sub_accounts/{sub_account_id}

List Pages

GET /unbounce/pages

Get Page

GET /unbounce/pages/{page_id}

List Page Form Fields

GET /unbounce/pages/{page_id}/form_fields

List Page Leads

GET /unbounce/pages/{page_id}/leads

Get Lead

GET /unbounce/leads/{lead_id}

List Domains

GET /unbounce/sub_accounts/{sub_account_id}/domains

Get Domain

GET /unbounce/domains/{domain_id}

List Page Groups

GET /unbounce/sub_accounts/{sub_account_id}/page_groups

List Page Group Pages

GET /unbounce/page_groups/{page_group_id}/pages

Create Lead

POST /unbounce/pages/{page_id}/leads
Content-Type: application/json

{
  "conversion": true,
  "visitor_id": "unique-visitor-id",
  "form_submission": {
    "variant_id": "a",
    "submitter_ip": "127.0.0.1",
    "form_data": {
      "name": "John Doe",
      "email": "john@example.com"
    }
  }
}

Get Current User

GET /unbounce/users/self

Get User

GET /unbounce/users/{user_id}

Query Parameters

  • limit - Results per page (default: 50, max: 1000)
  • offset - Skip first N results
  • sort_order - asc or desc
  • from - Start date (RFC 5322 format)
  • to - End date (RFC 5322 format)
  • count - When true, only return count in metadata
  • role - Filter pages by role: viewer or author
  • with_stats - Include A/B test statistics (for /pages)
  • include_sub_pages - Include sub-page form fields (for /form_fields)

Notes

  • Page IDs are UUIDs, account/sub-account IDs are integers
  • All responses include metadata with HATEOAS navigation links
  • Page states: published or unpublished
  • Account states: active or suspended
  • Date format: RFC 5322 (e.g., 2026-03-04T10:54:34Z)

Resources