Home
Integrations
CaptiFi REST API

Developer integration

CaptiFi REST API + CaptiFi

Pull your venues, guest sign-ups and visit stats into any system with a read-only REST API and self-serve keys. Included on Growth and above. Free trial.

Start Free Trial See all integrations

Overview

What does the CaptiFi REST API integration do?

The CaptiFi REST API is a read-only JSON API over the same guest data your dashboard shows: venues, guest sign-ups and visit statistics, with self-serve keys you create and revoke yourself. Keys are stored hashed and shown once, you can hold up to five, and nothing a key can do changes your settings or records. For bespoke booking platforms, in-house CRMs, data warehouses and reporting spreadsheets. Included on the Growth plan and above.

The CaptiFi REST API exists for the systems no directory can cover: a bespoke booking platform, an in-house CRM, a data warehouse, a reporting spreadsheet a finance team already lives in. Rather than asking you to export a CSV every week, CaptiFi gives you a read-only JSON API over the same guest data your dashboard shows, with self-serve keys you create and revoke yourself.

Create a key in the dashboard, name it after the system that will use it, and send it as a bearer token against https://app.captifi.io/api/v1/customer. Four endpoints cover the ground: /venues for your sites, /guests for sign-ups with filtering and pagination, /stats for visit and opt-in totals over a period, and /me to confirm which account a key belongs to. Every response comes back in the same envelope, with your rows under data and paging or totals under meta, so a single client handles all of them.

The API is deliberately read-only. Nothing a key can do will change your splash pages, your settings or your guest records, which makes it safe to hand to a developer or an agency without handing over your dashboard. Keys are stored hashed like passwords and revealed exactly once, you can hold up to five at a time, and revoking one never affects the others. Pair the API with webhooks: webhooks for live events as guests arrive, the API to backfill history and build reports.

Accounts on Growth and above can also read their Rewards programme with the same keys: the programme and its venues, members, each member's points ledger, issued rewards, redemptions and offers, all under /api/v1/customer/rewards. Results come newest first with the usual paging and can be narrowed by member email or phone, tier, status, offer, venue or a time window. Those endpoints are read-only too and follow the account's Rewards switch and plan. Tills and kiosks use a separate terminal key against /api/v1/rewards-pos to check a reward code against the bill, redeem it once with a reference for the receipt, reverse that sale within 30 minutes, look up a member or award points for a sale. Every redeem carries an Idempotency-Key, so a till that retries after a dropped connection gets the same answer back instead of a second redemption.

What you get

Why connect CaptiFi REST API to CaptiFi

Your guest data in your own systems

Pull venues, guest sign-ups and visit statistics straight into a booking platform, CRM, warehouse or reporting tool, without a weekly CSV export and without waiting for a native connector to be built.

Read-only by design

A key can read your data and nothing else. It cannot edit splash pages, change settings or touch guest records, so handing one to a developer or agency carries none of the risk of sharing a dashboard login.

Self-serve keys, revocable one by one

Create up to five keys yourself, one per system, so you can retire or rotate a single integration without breaking the rest. Keys are stored hashed and shown once, exactly like a password.

One predictable response shape

Every endpoint returns rows under data and paging or totals under meta, so the client you write for guests works unchanged for venues and stats.

What data flows to CaptiFi REST API

Your venues and their identifiers

Guest sign-ups: name, email, phone where captured

Marketing and contact consent state per guest

First and most recent visit dates, visit counts

Visit and opt-in totals for any period you request

The account and plan a key belongs to

How it works

Up and running in minutes

Create an API key

Open API Keys in your CaptiFi dashboard and give the key a name matching the system that will use it. The key appears once, immediately after creation, so copy it straight away: it is stored hashed and cannot be shown again.

Authenticate your requests

Send the key as an Authorization: Bearer header, with Accept: application/json, against the base URL https://app.captifi.io/api/v1/customer.

Call the endpoints you need

Use /venues for your sites, /guests for sign-ups with filters and pagination, /stats for visit and opt-in totals, and /me to confirm the account. Responses always carry rows under data and paging under meta.

Add webhooks for live events

Use the API to pull history and build reports on your own schedule, and add a webhook endpoint so new sign-ups are pushed to you the second they happen rather than on your next poll.

Read the CaptiFi REST API setup guide

Step by step, with screenshots.

In the real world

How venues use CaptiFi REST API with CaptiFi

Hotel group

A group pulls guest sign-ups nightly into its own data warehouse so WiFi opt-ins sit alongside bookings and spend in the same reporting suite.

Restaurant chain

An in-house CRM calls /guests every hour with a date filter, so new opted-in diners appear in the marketing team tooling without anyone exporting a spreadsheet.

Agency

A marketing agency is given its own read-only key per client, builds a live footfall and opt-in dashboard from /stats, and the venue can revoke that single key at the end of the engagement.

FAQs

Frequently asked questions

Which plans include the CaptiFi API?

The API is included on the Growth plan and above, at no extra cost, alongside webhooks. A 30-day free trial started on Growth or Pro includes it, so you can build against it during the trial. On Essentials the API Keys page still explains what the API does and how to upgrade.

Can the API change anything in my account?

No. The customer API is read-only. Keys can read venues, guests and statistics, and cannot modify your splash pages, settings or guest records, which is why it is safe to hand a key to a developer or an agency.

How many keys can I have, and what if I lose one?

You can hold up to five keys at once, and using a separate key per system means you can revoke one without breaking the others. Keys are stored encrypted and shown only once at creation, so if you lose one, revoke it and create a replacement.

Should I use the API or webhooks?

Use webhooks when you want to react to a guest as they arrive and your system can accept an inbound HTTPS request. Use the API when you want to pull a list on your own schedule, or when your system can only make outbound requests. Plenty of setups use both: webhooks for live events, the API to backfill history.

Can I read my Rewards programme through the API?

Yes, on Growth and above, with the same keys: the programme and its venues, members, each member's points ledger, issued rewards, redemptions and offers under /api/v1/customer/rewards, read-only and following your Rewards switch and plan. A till or kiosk that needs to redeem uses a separate terminal key against /api/v1/rewards-pos, with an Idempotency-Key on every redeem so a retry never redeems twice.

Where is the endpoint reference?

The full reference, including authentication, filters, pagination and example responses, is in the CaptiFi documentation at docs.captifi.io under Dashboard, API.

Pairs well with

Webhooks Zapier HubSpot

Start using CaptiFi REST API with CaptiFi today

30-day free trial. Cancel anytime.

Start Free Trial Browse all integrations

Google, Gmail, Mailchimp, Klaviyo, HubSpot, Salesforce, Facebook, Meta Pixel, Slack, Zapier, Twilio, Tripadvisor, Yelp, Toast, Square, SumUp, Airship, Revinate, Leat, Pepper, EmailOctopus, Incentivio and ChatGPT are trade marks of their respective owners and appear here only to identify the services CaptiFi connects to. CaptiFi is independent of these companies and is not sponsored, certified or endorsed by them. An integration marked coming soon is on our roadmap and is not yet available. Twilio and all related logos are trademarks of Twilio Inc. or its affiliates. Salesforce is a trademark of Salesforce, Inc. Slack is a trademark and service mark of Slack Technologies, Inc., registered in the U.S. and in other countries.