Zapmail
latest
  • latest
  • v1
latest
  • latest
  • v1
Sign In
latest
  • latest
  • v1
Root
Root
  1. Zapsites
  • Zapmail Docs
  • users
    • Retrieve User Details
      GET
  • quick setup
    • Quick Setup
      POST
  • workspaces
    • Retrieve all workspaces
      GET
    • Create new workspace
      POST
    • Update workspace
      PUT
    • List all workspace members
      GET
    • Update user role
      PUT
    • Revoke User Access
      DELETE
    • Send invitiation to join workspace
      POST
    • List all invitations
      GET
    • Revoke invitation
      DELETE
    • Update Domain Renewal Settings
      POST
  • billing
    • Add Billing Details
      POST
    • Update Billing Details
      PUT
  • mailbox
    • Retrieve All Mailboxes
      GET
    • Get Mailbox Details by ID
      GET
    • Assign New Mailboxes to Domains
      POST
    • Update mailbox
      PUT
    • Remove mailboxes on next renewal
      PUT
    • Get Authenticator code
      GET
    • Custom OAuth
      POST
    • schedule mailbox creation
      POST
    • retry creation of failed mailboxes
      PUT
  • payments & wallet
    • Add balance to wallet
    • Get wallet balance
    • Enable auto recharge
    • Purchase add on mailboxes
    • get invoices for subscription
  • export
    • Export mailboxes
    • Add third party account details
    • Update third party account details
    • Get Export Status
    • Fetch Workspaces by App
    • List all third-party accounts
  • subscriptions
    • Get all subscriptions
    • Cancel subscription
    • Upgrade existing subscription
    • Purchase subscription
    • Get Mailboxes in a Subscription
  • domains
    • Retrieve All Domains
    • List Assignable Domains
    • Add DMARC record
    • Add Domain forwarding
    • Get Name servers to connect domain
    • Verify Name Server Propagation
    • Connect Domain with Zapmail
    • Enable email forwarding
    • Remove email forwarding
    • Enable catch all emails
    • Remove catch all emails
    • Check DNS records
    • Remove unused domains
    • Get available domains for registration
    • Get domains purchase payment link
    • Get domain connection requests
    • Remove domain connection requests
    • Connect Domain with Zapmail (New)
    • Add Google Client ID to Domain
    • Get availability of multiple domain names.
    • Retrieve Domain Health Score
    • Retrieve All Domains (With filters)
    • AI Domain Finder
    • Move Domains Across workspace
    • Assign Domain Tag
    • list domain tags
    • Create Domain Tags
    • Remove Domain Forwarding
    • List Domains Eligible for Renewal
    • Get Renewal Price
    • Renew Domains
    • Delete Tag
    • Remove Tags From Domains
    • Update Auto Renew Preference
  • dns
    • Get dns records
    • Add dns records
    • Update dns records
    • Delete dns records
  • High Reputation Domains
    • Get available domains
    • Purchase high reputation domains
  • prewarmed domains
    • Get prewarmed domains
    • purchase prewarmed subscription
    • Assign prewarmed mailboxes
    • Get Available Domains Count
    • Get Prewarm Subscriptions
  • placement test
    • Get subscriptions
    • Get Overall Report
    • Get placement test orders
    • Get report by cart order id
    • Get Eligible Mailboxes for Placement Tests
    • Get Available Placement Test Credits
    • Purchase Placement Test
    • Purchase plan
    • Cancel Subscription
  • dns shield
    • Get eligible domains
    • Get available slots
    • Get subscriptions
    • Get Allocated Domains for Subscription
    • Allocate Domains to DNS Shield
    • Purchase DNS Shield
    • Upgrade DNS Shield LTD Plan
    • Cancel subscription
  • Zapsites
    • Scan A Site
      GET
    • Create a New Zapsite
      POST
    • Fetch A Zapsite
      GET
    • Edit a Zapsite
      PATCH
    • Regenerate a Zapsite
      POST
    • Deploy a Zapsite
      GET
  • global
    • Global mailbox-domain search
  • zapbox
    • List Connected Accounts
    • Fetch emails
    • get emails from a thread
    • Search emails
    • Send Email
    • Download Attachment
    • Create New Label
    • Delete Label
    • Rename Label
  • Schemas
    • domain with filter
  1. Zapsites

Fetch A Zapsite

GET
/v2/zap-sites/{id}
Returns the full ZapSite state: metadata, current copy, all deployments, recent leads, recent visitors, and a 14-day visitor timeseries.

Request

Path Params

Header Params

Responses

🟢200Success
application/json
Bodyapplication/json

🟠422Invalid ID
🟠404Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.zapmail.ai/api/v2/zap-sites/030c0097-066d-47a3-bf66-63cbb6ca71f5' \
--header 'x-auth-zapmail: 83aea076-daf9-41d8-819d-ff381b96fca1' \
--header 'x-workspace-key: 66317ff5-3077-4580-88a2-9817ab79bc8d' \
--header 'x-service-provider: GOOGLE'
Response Response Example
200 - Success
{
    "status": 200,
    "message": "ZapSite fetched successfully",
    "data": {
        "id": "5b1e0c2a-4f3e-4a9d-9c7c-6a2b6e1a7d10",
        "userId": "8a2f9d3e-1b2c-4d5e-8f6a-2c3d4e5f6a7b",
        "workspaceId": "8a2f9d3e-1b2c-4d5e-8f6a-2c3d4e5f6a7b",
        "name": "Example Q4 Cold Outreach",
        "destinationUrl": "https://example.com/pricing",
        "campaignContext": "Targeting VP Sales at 50-500 person B2B SaaS companies for our Q4 outbound push.",
        "audience": [
            "VP Sales",
            "RevOps"
        ],
        "ctaLabel": "Book a demo",
        "theme": "auto",
        "status": "LIVE",
        "version": 2,
        "scan": {
            "title": "Example — Modern SaaS for Sales Teams",
            "primary_color": "#1F6FEB",
            "secondary_color": "#0B1220"
        },
        "copy": {
            "headline": "Book more demos without more busywork",
            "subheadline": "Example gives VP Sales the pipeline visibility they need.",
            "cta_label": "Book a demo",
            "sections": [
                {
                    "title": "Why teams switch",
                    "body": "Reps spend 40% less time on admin."
                }
            ]
        },
        "logoUrl": "https://cdn.zapmail.ai/zapsites/logos/5b1e0c2a.png",
        "formFields": [
            {
                "name": "work_email",
                "label": "Work email",
                "type": "email",
                "required": true
            },
            {
                "name": "company",
                "label": "Company",
                "type": "text",
                "required": false
            }
        ],
        "notifyEmail": "random@example.com",
        "slackWebhook": null,
        "lastError": null,
        "createdAt": "2026-09-01T10:15:32.421Z",
        "updatedAt": "2026-09-04T09:02:11.009Z",
        "deletedAt": null,
        "deployments": [
            {
                "id": "d3f1a2b4-5c6d-4e7f-8a9b-0c1d2e3f4a5b",
                "siteId": "5b1e0c2a-4f3e-4a9d-9c7c-6a2b6e1a7d10",
                "domainId": "c1a2b3c4-d5e6-4f70-8a9b-1c2d3e4f5a6b",
                "domain": "example-outreach.com",
                "indexing": false,
                "tracking": true,
                "formEnabled": true,
                "status": "LIVE",
                "railwayDomainId": "rwy_9f8e7d6c5b4a",
                "edgeIp": "198.51.100.42",
                "lastError": null,
                "createdAt": "2026-09-01T10:20:00.000Z",
                "updatedAt": "2026-09-01T10:22:14.000Z",
                "deletedAt": null
            }
        ],
        "leads": [
            {
                "id": "e4f5a6b7-8c9d-4e0f-9a1b-2c3d4e5f6a7b",
                "siteId": "5b1e0c2a-4f3e-4a9d-9c7c-6a2b6e1a7d10",
                "deploymentDomain": "example-outreach.com",
                "fields": {
                    "work_email": "jordan@buyerco.com",
                    "company": "BuyerCo"
                },
                "referrer": "https://mail.google.com/",
                "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)",
                "ip": "203.0.113.9",
                "createdAt": "2026-09-03T14:02:00.000Z"
            }
        ],
        "visitors": [
            {
                "id": "f5a6b7c8-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
                "siteId": "5b1e0c2a-4f3e-4a9d-9c7c-6a2b6e1a7d10",
                "event": "pageview",
                "createdAt": "2026-09-04T08:55:00.000Z"
            }
        ],
        "visitorDaily": [
            {
                "date": "2026-08-22",
                "pageviews": 0,
                "ctaClicks": 0
            },
            {
                "date": "2026-09-04",
                "pageviews": 12,
                "ctaClicks": 3
            }
        ],
        "counts": {
            "leads": 1,
            "visitors": 48
        }
    }
}
Modified at 2026-09-07 11:26:01
Previous
Create a New Zapsite
Next
Edit a Zapsite
Built with