# SignUpBreeze Documentation

> Learn how to create events, manage volunteer signups, and get the most out of SignUpBreeze.

## Docs

- [What is SignUpBreeze?](https://docs.signupbreeze.com/getting-started/introduction.md): A modern, mobile-first volunteer signup platform that's clean, fast, and ad-free.
- [Key Concepts](https://docs.signupbreeze.com/getting-started/key-concepts.md): The core building blocks of SignUpBreeze — organizations, events, slots, registrations, and magic links.
- [Quickstart](https://docs.signupbreeze.com/getting-started/quickstart.md): Create your first event in under 5 minutes.
- [Creating Events](https://docs.signupbreeze.com/organizers/creating-events.md): How to create and configure events in SignUpBreeze using templates or from scratch.
- [Managing Shifts](https://docs.signupbreeze.com/organizers/managing-shifts.md): How to add, edit, and organize shifts within your events.
- [Managing Signups](https://docs.signupbreeze.com/organizers/managing-signups.md): How to view and manage volunteer registrations for your events.
- [Custom Questions](https://docs.signupbreeze.com/organizers/custom-questions.md): Build a reusable library of sign-up questions and attach them to your events.
- [Reminders](https://docs.signupbreeze.com/organizers/reminders.md): How volunteer shift reminders work and how to customize when they send.
- [Managing Waitlists](https://docs.signupbreeze.com/organizers/managing-waitlists.md): Let volunteers join a waitlist when shifts fill up, and manage who gets promoted.
- [Sharing Events](https://docs.signupbreeze.com/organizers/sharing-events.md): How to share your event with volunteers using links, QR codes, and social sharing.
- [Team Calendars](https://docs.signupbreeze.com/organizers/team-calendars.md): Connect a PlayMetrics calendar so your team's games appear automatically, with parents signing up for drinks and snacks.
- [Signing Up for an Event](https://docs.signupbreeze.com/volunteers/signing-up.md): How to sign up for a volunteer shift — no account needed.
- [Magic Links](https://docs.signupbreeze.com/volunteers/magic-links.md): How magic links work and how to use them to manage your signup.
- [Managing Your Registrations](https://docs.signupbreeze.com/volunteers/managing-registrations.md): How to view and manage your volunteer signups.
- [Joining a Waitlist](https://docs.signupbreeze.com/volunteers/waitlists.md): How to join a waitlist for a full shift and what happens when a spot opens up.
- [Profile Settings](https://docs.signupbreeze.com/account/profile.md): How to update your name, email, and timezone, and delete your account.
- [Signing In & Security](https://docs.signupbreeze.com/account/security.md): How to sign in to SignUpBreeze with a one-time email code or a social account.
- [Organizations](https://docs.signupbreeze.com/account/organizations.md): Collaborate with others by creating and managing organizations.
- [Billing & Plans](https://docs.signupbreeze.com/account/billing.md): Compare plans and manage your organization's subscription.
- [Appearance Settings](https://docs.signupbreeze.com/account/appearance.md): Switch between light mode, dark mode, or system default.
- [Notification Settings](https://docs.signupbreeze.com/account/notifications.md): Control which email notifications you receive from SignUpBreeze.
- [Getting Help](https://docs.signupbreeze.com/account/support.md): How to reach us, and what support is included on your plan.
- [API Introduction](https://docs.signupbreeze.com/api-reference/introduction.md): Manage events, shifts, and signups programmatically — from your own scripts, an automation platform, or an AI agent.
- [Authentication](https://docs.signupbreeze.com/api-reference/authentication.md): How API tokens work, who they belong to, and when they expire.
- [Scopes](https://docs.signupbreeze.com/api-reference/scopes.md): What each permission grants, and how to choose the smallest set an integration needs.
- [Idempotency](https://docs.signupbreeze.com/api-reference/idempotency.md): Send an Idempotency-Key so a retried write happens once, not twice.
- [Pagination](https://docs.signupbreeze.com/api-reference/pagination.md): Collections are cursor paginated. Follow meta.next_cursor rather than counting pages.
- [Errors](https://docs.signupbreeze.com/api-reference/errors.md): What each status code means and what to do about it.
- [List events](https://docs.signupbreeze.com/api-reference/events/list-events.md): Returns the organization's events, soonest-starting last. Cursor paginated: follow `meta.next_cursor` rather than assuming page numbers.
- [Create an event](https://docs.signupbreeze.com/api-reference/events/create-an-event.md): Creates an event and, optionally, all of its shifts in the same call — which is usually what you want, since an event with no shifts has nothing to sign up for.
- [Get an event](https://docs.signupbreeze.com/api-reference/events/get-an-event.md): Returns one event with its shifts and how full each one is. To ask only "what still needs people?", use the coverage endpoint instead — it answers that in one call.
- [Delete an event](https://docs.signupbreeze.com/api-reference/events/delete-an-event.md): Deletes the event and its shifts. Everyone with a confirmed signup is emailed that it was cancelled, so this is not a quiet operation — unpublish instead if you only want it out of sight.
- [Update an event](https://docs.signupbreeze.com/api-reference/events/update-an-event.md): Send only the fields you are changing; anything omitted keeps its current value. Publish an event by sending `is_published: true`.
- [Get an event's coverage](https://docs.signupbreeze.com/api-reference/events/get-an-events-coverage.md): Answers "what still needs people?" in one call: how full every shift is, plus a summary of the event as a whole.
- [Duplicate an event](https://docs.signupbreeze.com/api-reference/events/duplicate-an-event.md): Copies the event, its shifts, and its signup questions to a new start date. Shift times shift along with it, keeping their time of day. Signups are **not** copied.
- [Get the current organization](https://docs.signupbreeze.com/api-reference/organization/get-the-current-organization.md): Returns the organization the request's token was issued to. Tokens belong to an organization rather than to a person, so there is no id to pass — a token can only ever see its own.
- [List an event's shifts](https://docs.signupbreeze.com/api-reference/shifts/list-an-events-shifts.md): Returns every shift on the event in running order, with how full each one is. Not paginated: events have shifts, not thousands of them.
- [Add a shift](https://docs.signupbreeze.com/api-reference/shifts/add-a-shift.md): Adds a shift to an existing event. Times are wall-clock (`14:30`) and are read in the event's own timezone — do not send an offset or a date.
- [Delete a shift](https://docs.signupbreeze.com/api-reference/shifts/delete-a-shift.md): Deletes the shift. Anyone with a confirmed signup on it is emailed that it was cancelled.
- [Update a shift](https://docs.signupbreeze.com/api-reference/shifts/update-a-shift.md): Send only the fields you are changing. Changing the time or location emails the volunteers already signed up; pass `notify_volunteers: false` to suppress that.
- [List an event's signups](https://docs.signupbreeze.com/api-reference/signups/list-an-events-signups.md): Returns the event's signups oldest first, so paging through them follows the order people actually signed up. Cursor paginated.
- [Changelog](https://docs.signupbreeze.com/changelog.md): New features, improvements, and milestones for SignUpBreeze.

## OpenAPI Specs

- [openapi](https://api.signupbreeze.com/openapi.yaml)

## Optional

- [SignUpBreeze.com](https://signupbreeze.com)