# API Overview

Section: API · Page: https://artsvp.com/docs/api/overview

(Plans: Expert) (Access: Admins only)

The ARTSVP REST API connects event and guest data to websites, CRMs, access
systems, and other internal tools, the ongoing integration you reach for when
point-in-time CSV exports stop being enough. Version 3 is the current API, and
the complete endpoint and payload reference is at
[docs.artsvp.com](https://docs.artsvp.com). Only organisation admins manage API
access.

## Authentication

1. Go to **Settings** → **Developer**.
2. Under **API Authentication**, click **Generate Token**.
3. Copy the token when it appears and store it in your secret manager. It is
   shown once.
4. Send it in the `Authorization` header on HTTPS requests to the v3 API.

Regenerating the token stops the previous token immediately, so update every
client before making the new token the only stored copy. A token grants
organisation-level data access: never put one in browser code, a public
repository, or a booking-page script. API requests must use HTTPS in
production.

## What version 3 supports

| Resource | Capabilities |
|---|---|
| Events | List events; get one event with tickets, extras, availability, sold-out status, whether it takes a waitlist, and whether it has been cancelled (`cancelled`, `cancelled_at`). Archived tickets and extras are omitted. |
| Collections | List collections; get one collection and its events. |
| Invitations | List, filter, create, update, delete, and batch-create by resource tag. |
| Bookings | List, filter, get, create, and update bookings. |

Lists support pagination and resource-specific filters. Public IDs identify
resources in API paths and payloads.

Version 3 exposes the resources above, not every admin action. Confirm in the
endpoint reference that an operation is supported before designing an
integration around it.

## Rate limits

The API allows 1,000 requests per 15-minute window per organisation. A client
that exceeds the limit is paused for five minutes. Read the rate-limit response
headers and back off before the remaining count reaches zero.

## Webhooks

Use webhooks when your system should react as ARTSVP activity happens rather
than polling the API. Under **Settings** → **Developer**, add an HTTPS
endpoint, choose the events it receives, and monitor its status. Version 3
sends `booking.created`, `booking.confirmed`, `booking.updated`,
`booking.cancelled`, `event.created`, `event.updated`, `event.published`,
`event.cancelled`, and `event.archived`. A ticket or extra change sends
`event.updated`. See the [webhook reference](https://docs.artsvp.com#webhooks)
for payloads.

---

Keep reading: [Integrations](https://artsvp.com/docs/settings/integrations) ·
[Reporting and exports](https://artsvp.com/docs/reference/reporting-and-exports) ·
[Legal and privacy](https://artsvp.com/docs/reference/legal)

---