# Swoogo Developer Documentation ## Docs - [Request API Token](https://developer.swoogo.com/api-reference/authentication/request-api-token.md): ### Request API Token **Step 1: Find your consumer key and secret** Your consumer key and secret can be found by logging into Swoogo, and going to My Profile > API Credentials. - [Create Contact](https://developer.swoogo.com/api-reference/call-for-speaker-contacts/create-contact.md): Creates a new contact in the Call for Speakers program for an event. Provide the contact's profile information (name, email, company, bio) to add them as a potential speaker. They can then be associated with submissions. - [Delete Contact](https://developer.swoogo.com/api-reference/call-for-speaker-contacts/delete-contact.md): Permanently deletes a Call for Speakers contact by their ID. This removes the contact from the CFS program and may affect associated submissions. - [Get All Contacts](https://developer.swoogo.com/api-reference/call-for-speaker-contacts/get-all-contacts.md): Retrieves all contacts who have submitted or been invited to the Call for Speakers (CFS) program for an event. CFS contacts are potential speakers with their profile information and submission status. Requires the `event_id` query parameter. - [Get One Contact](https://developer.swoogo.com/api-reference/call-for-speaker-contacts/get-one-contact.md): Retrieves a single Call for Speakers contact by their ID, including profile information (name, email, company, bio) and their submission status within the CFS program. - [Update Contact](https://developer.swoogo.com/api-reference/call-for-speaker-contacts/update-contact.md): Updates an existing Call for Speakers contact by their ID. You can modify profile fields such as name, email, company, bio, and other speaker-related information. - [Create Review](https://developer.swoogo.com/api-reference/call-for-speaker-reviews/create-review.md): Creates a new review for a Call for Speakers submission. Provide the `event_id`, `submission_id`, reviewer information, score, and optional feedback comments to record an evaluation of a speaker submission. - [Delete Review](https://developer.swoogo.com/api-reference/call-for-speaker-reviews/delete-review.md): Permanently deletes a submission review by its ID. This removes the reviewer's score and feedback from the submission's evaluation record. - [Get All Reviews](https://developer.swoogo.com/api-reference/call-for-speaker-reviews/get-all-reviews.md): Retrieves all reviews for Call for Speakers submissions for an event. Reviews contain scores and feedback from reviewers evaluating speaker submissions. Requires the `event_id` query parameter. Use this to aggregate review scores and track the submission evaluation process. - [Get One Review](https://developer.swoogo.com/api-reference/call-for-speaker-reviews/get-one-review.md): Retrieves a single submission review by its ID, including the reviewer, score, feedback comments, and the associated submission. - [Update Review](https://developer.swoogo.com/api-reference/call-for-speaker-reviews/update-review.md): Updates an existing submission review by its ID. You can modify the score, feedback comments, and reviewer details. - [Create Submission](https://developer.swoogo.com/api-reference/call-for-speaker-submissions/create-submission.md): Creates a new speaker submission for an event's Call for Speakers program. Provide the `event_id`, session topic, abstract, and speaker contact information. The submission enters the review pipeline where it can be evaluated, scored, and accepted or rejected. - [Delete Submission](https://developer.swoogo.com/api-reference/call-for-speaker-submissions/delete-submission.md): Permanently deletes a speaker submission by its ID. This removes the submission and all associated reviews from the Call for Speakers program. - [Get All Submissions](https://developer.swoogo.com/api-reference/call-for-speaker-submissions/get-all-submissions.md): Retrieves all speaker submissions for an event's Call for Speakers program. Each submission contains the proposed session topic, abstract, speaker contact, and current review status (e.g., pending, accepted, rejected). Requires the `event_id` query parameter. - [Get One Submission](https://developer.swoogo.com/api-reference/call-for-speaker-submissions/get-one-submission.md): Retrieves a single speaker submission by its ID, including the session topic, abstract, speaker contact details, track preference, review status, and reviewer scores. - [Update Submission](https://developer.swoogo.com/api-reference/call-for-speaker-submissions/update-submission.md): Updates an existing speaker submission by its ID. You can modify the session topic, abstract, speaker details, track preference, and review status. - [Get All Fields](https://developer.swoogo.com/api-reference/contact-fields/get-all-fields.md): Returns a paginated list of custom field definitions available for contacts. These define the schema for custom data that can be stored on contact records beyond the standard fields. Each entry includes the field's type, name, and configuration. Use `search` to filter and `fields` to limit returned… - [Get One Field](https://developer.swoogo.com/api-reference/contact-fields/get-one-field.md): Returns the full details of a single contact custom field definition by `field_id`, including its type, name, configuration, and available choices (for dropdown or multi-select fields). Use `fields` to limit which properties are returned. - [Create Contact](https://developer.swoogo.com/api-reference/contacts/create-contact.md): Creates a new CRM contact. The `email` field is required and must be unique within your account. You can also provide first_name, last_name, company, job_title, and other profile fields. Returns the newly created contact object. Once created, the contact can be linked to events as a registrant or sp… - [Forget Contact](https://developer.swoogo.com/api-reference/contacts/forget-contact.md): Performs a GDPR “right to be forgotten” operation on a contact by `contact_id`. This anonymizes the contact's personal data and optionally removes credit card holder names. Provide `registrantIds` as a JSON array to also anonymize specific linked registrant records. This action is irreversible -- al… - [Get All Contacts](https://developer.swoogo.com/api-reference/contacts/get-all-contacts.md): Returns a paginated list of CRM contacts across all events in your account. Unlike registrants, contacts are not event-specific and can be linked to registrations across multiple events. Default fields returned are `id`, `first_name`, and `last_name` -- use `fields` to request additional properties.… - [Get One Contact](https://developer.swoogo.com/api-reference/contacts/get-one-contact.md): Returns the full details of a single CRM contact by `contact_id`, including personal information, company, email, phone numbers, and profile data. Use `fields` to limit which properties are returned and `expand` to include related address objects. - [Update Contact](https://developer.swoogo.com/api-reference/contacts/update-contact.md): Updates an existing CRM contact by `contact_id`. Send only the fields you want to change -- any omitted fields retain their current values. Changes to contact data may propagate to linked speaker records that pull profile information from this contact. - [Create Data List Item](https://developer.swoogo.com/api-reference/data-list-items/create-data-list-item.md): Creates a new item within a data list. Requires `data_list_id` and the item `value` in the request body. The new item will appear as a selectable option in any custom field that references this data list. - [Delete Data List Item](https://developer.swoogo.com/api-reference/data-list-items/delete-data-list-item.md): Permanently deletes an item from a data list. The option will no longer appear in custom field dropdowns. Existing registrant records that selected this item will retain the value but it will not be selectable for new entries. - [Get All Data List Items](https://developer.swoogo.com/api-reference/data-list-items/get-all-data-list-items.md): Retrieves all items within a specific data list. Items are the individual options (e.g., "United States", "Canada") that appear in dropdown or checkbox fields on registration forms. Filter by `data_list_id` to get items for a specific list. - [Get One Data List Item](https://developer.swoogo.com/api-reference/data-list-items/get-one-data-list-item.md): Retrieves a single data list item by its ID, including the item value, sort order, and parent list reference. - [Update Data List Item](https://developer.swoogo.com/api-reference/data-list-items/update-data-list-item.md): Updates an existing data list item by its ID. You can modify the item value and sort order. - [Create Data List](https://developer.swoogo.com/api-reference/data-lists/create-data-list.md): Creates a new data list. Requires `name` in the request body. After creating the list, use the Data List Items endpoints to add individual options to the list. - [Delete Data List](https://developer.swoogo.com/api-reference/data-lists/delete-data-list.md): Permanently deletes a data list and all its items. Custom fields that reference this list will lose their option set and may need to be reconfigured. - [Get All Data Lists](https://developer.swoogo.com/api-reference/data-lists/get-all-data-lists.md): Retrieves all data lists for your account. Data lists are reusable sets of options (e.g., countries, industries, dietary preferences) that can be assigned to custom fields across multiple events. Each list contains items that serve as dropdown or checkbox options on registration forms. - [Get One Data List](https://developer.swoogo.com/api-reference/data-lists/get-one-data-list.md): Retrieves a single data list by its ID, including the list name and notes. - [Update Data List](https://developer.swoogo.com/api-reference/data-lists/update-data-list.md): Updates an existing data list by its ID. You can modify the list name and notes. - [Clone Discount Code](https://developer.swoogo.com/api-reference/discount-codes/clone-discount-code.md): Creates a duplicate of an existing discount code, copying all settings (type, amount, capacity, line item rules, and group constraints). Optionally provide a new `code` value via the `code` query parameter; if omitted, the original code is used with "(Clone)" appended. Alternate discount codes canno… - [Create Discount Code](https://developer.swoogo.com/api-reference/discount-codes/create-discount-code.md): Creates a new discount code for an event. Requires `event_id`, `code`, and `type` (`percentage`, `absolute`, or `specific`). Set `capacity` to limit total usage, `apply_to_all` to apply across every line item, or list specific items in `applicable_line_items` for targeted discounts. For `specific`-t… - [Delete Discount Code](https://developer.swoogo.com/api-reference/discount-codes/delete-discount-code.md): Permanently deletes a discount code by its ID. The code will no longer be usable for future registrations. Existing registrants who already applied this discount are not affected. - [Get All Discount Codes](https://developer.swoogo.com/api-reference/discount-codes/get-all-discount-codes.md): Retrieves all discount codes for a specific event. Discount codes can be percentage-based, absolute (fixed amount), or specific (custom fees per line item). Requires the `event_id` query parameter. Use `expand` to include `alternates`, `autopopulate` field mappings, `registrantCount`, or `reservedCo… - [Get One Discount Code](https://developer.swoogo.com/api-reference/discount-codes/get-one-discount-code.md): Retrieves a single discount code by its ID, including discount type (`percentage`, `absolute`, or `specific`), applicable line items, capacity limits, line-item-specific fees (`custom_fees`), and group registration settings. - [Update Discount Code](https://developer.swoogo.com/api-reference/discount-codes/update-discount-code.md): Updates an existing discount code by its ID. All body fields are optional; only the fields included in the request body will be updated. `event_id` cannot be changed — discounts are bound to their original event. To create alternate codes for an existing discount, use the clone endpoint. - [Create Badge](https://developer.swoogo.com/api-reference/event-badges/create-badge.md): Creates a new badge template for an event. Configure the badge layout, dimensions, and which registration types should use this badge for on-site printing. - [Get All Badges](https://developer.swoogo.com/api-reference/event-badges/get-all-badges.md): Retrieves all badge templates configured for an event. Badges are printable name tags or credentials for on-site check-in. Each badge includes its layout configuration and associated registration types. - [Get One Badge](https://developer.swoogo.com/api-reference/event-badges/get-one-badge.md): Retrieves a single badge template by its ID, including the layout configuration, dimensions, and associated registration types. - [Create Field](https://developer.swoogo.com/api-reference/event-fields/create-field.md): Creates a new custom field definition for events. Specify the field name, type (text, dropdown, checkbox, etc.), visibility, sort order, and choices (for selection-type fields). The field will become available for data entry on events. - [Delete Field](https://developer.swoogo.com/api-reference/event-fields/delete-field.md): Permanently deletes a custom event field definition by its ID. Any data stored in this field on existing events will no longer be accessible. - [Get All Fields](https://developer.swoogo.com/api-reference/event-fields/get-all-fields.md): Retrieves all custom field definitions for events. These fields define the schema for additional event-level data (e.g., custom text fields, dropdowns, URLs). Each field includes its attribute name, display type, visibility, sort order, validation requirements, and available choices. - [Get One Field](https://developer.swoogo.com/api-reference/event-fields/get-one-field.md): Retrieves a single custom event field definition by its ID, including the attribute name, field type, visibility settings, validation rules, and available choices (for dropdown/radio fields). - [Update Field](https://developer.swoogo.com/api-reference/event-fields/update-field.md): Updates an existing custom event field definition by its ID. You can modify the field name, type, visibility, sort order, validation rules, and available choices. - [Get All Folders](https://developer.swoogo.com/api-reference/event-folders/get-all-folders.md): Retrieves all event folders used to organize events in the dashboard. Folders support a hierarchical structure via `parent_id` for nested organization. Read-only endpoint. - [Get One Folder](https://developer.swoogo.com/api-reference/event-folders/get-one-folder.md): Retrieves a single event folder by its ID, including the folder name and parent folder reference for hierarchical navigation. - [Get All Questions](https://developer.swoogo.com/api-reference/event-questions/get-all-questions.md): Retrieves all registration form questions configured for an event. Questions define the fields that registrants fill out during registration (e.g., name, email, custom questions). Defaults to questions on the main website but can be filtered by module. Requires the `event_id` query parameter. Extra Fields - [Get All Websites](https://developer.swoogo.com/api-reference/event-websites/get-all-websites.md): Retrieves all websites associated with an event. Each event can have multiple websites (e.g., main registration site, speaker portal, exhibitor portal). Requires the `event_id` query parameter. Read-only endpoint. - [Get One Website](https://developer.swoogo.com/api-reference/event-websites/get-one-website.md): Retrieves a single event website by its ID, including the site URL, configuration, and associated pages. - [Clone Event](https://developer.swoogo.com/api-reference/events/clone-event.md): Creates a new event by cloning an existing one. Copies all event settings including registration types, packages, sessions, forms, and website configuration into a new event. - [Create Event](https://developer.swoogo.com/api-reference/events/create-event.md): Creates a new event in your account. Returns the full event record on success. - [Get All Events](https://developer.swoogo.com/api-reference/events/get-all-events.md): Retrieves a paginated list of events for your account. Returns event configuration, scheduling, and status information. - [Get One Event](https://developer.swoogo.com/api-reference/events/get-one-event.md): Retrieves a single event by its unique ID. Returns the full event record including name, dates, times, timezone, capacity, status, and registration URL. - [Update Event](https://developer.swoogo.com/api-reference/events/update-event.md): Updates an existing event by its unique ID. Only the fields included in the request body are modified; omitted fields are left unchanged. - [Formatting conventions](https://developer.swoogo.com/api-reference/formatting-conventions.md): Data formats and standards used across all API endpoints - [Delete Image Field](https://developer.swoogo.com/api-reference/images/delete-image-field.md): Removes an image from a specific field on an object. The image file is deleted and the field is cleared. Requires `image_type`, `image_id`, and `field_id` as path parameters. - [Get Image URL](https://developer.swoogo.com/api-reference/images/get-image-url.md): Retrieves the URL for an image associated with a specific object (e.g., event logo, speaker photo, sponsor banner). Requires `image_type` (the object type), `image_id` (the object's ID), and `field_id` (the image field) as path parameters. - [Update Image Field](https://developer.swoogo.com/api-reference/images/update-image-field.md): Uploads or replaces an image for a specific field on an object (registrant, contact, or sponsor). Send as a `multipart/form-data` request with a single `file` parameter containing the image. The file must be no larger than 5MB and use a valid extension: jpg, jpeg, gif, png, webp, or svg. The `image_… - [Introduction](https://developer.swoogo.com/api-reference/introduction.md): Everything you need to start building with the Swoogo API - [Add Contact to Invitation List](https://developer.swoogo.com/api-reference/invitation-lists/add-contact-to-invitation-list.md): Adds a contact to an invitation list, granting them permission to register for the associated event. Requires `invitation_list_id` as a path parameter and `contact_id` in the request body. The contact must already exist in your account's contact database. - [Create Invitation List](https://developer.swoogo.com/api-reference/invitation-lists/create-invitation-list.md): Creates a new invitation list for an event. Requires `event_id` and `name` in the request body. After creating the list, use the Add Contact endpoint to populate it with contacts who should be invited to register. - [Get All Invitation Lists](https://developer.swoogo.com/api-reference/invitation-lists/get-all-invitation-lists.md): Retrieves all invitation lists for your account. Invitation lists are curated groups of contacts who are invited to register for specific events. Lists can be used to control registration access when invitation-only mode is enabled on an event. - [Get Invitation List](https://developer.swoogo.com/api-reference/invitation-lists/get-invitation-list.md): Retrieves a single invitation list by its ID, including the list name, associated event, and capacity settings. - [Remove Contact from Invitation List](https://developer.swoogo.com/api-reference/invitation-lists/remove-contact-from-invitation-list.md): ### Invitation Lists This endpoint removes a contact from an existing invitation list. It returns a success response when the contact is successfully removed. - [Update Invitation List](https://developer.swoogo.com/api-reference/invitation-lists/update-invitation-list.md): Updates an existing invitation list by its ID. You can modify the list name and capacity settings. - [Overview](https://developer.swoogo.com/api-reference/overviews/call-for-speaker-reviews.md): Manage reviews of call for speaker submissions - [Overview](https://developer.swoogo.com/api-reference/overviews/call-for-speaker-submissions.md): Manage speaker proposals submitted to a call for speakers program - [Overview](https://developer.swoogo.com/api-reference/overviews/call-for-speakers.md): Manage speaker submission programs — contacts, submissions, and reviews - [Overview](https://developer.swoogo.com/api-reference/overviews/contact-fields.md): View custom field definitions for CRM contacts - [Overview](https://developer.swoogo.com/api-reference/overviews/contacts.md): People in your Swoogo CRM, independent of any specific event - [Overview](https://developer.swoogo.com/api-reference/overviews/data-list-items.md): Manage individual items within a data list - [Overview](https://developer.swoogo.com/api-reference/overviews/data-lists.md): Reusable sets of options used in custom fields — dropdowns, checkboxes, and more - [Overview](https://developer.swoogo.com/api-reference/overviews/discounts.md): Percentage or fixed-amount discounts on registration fees - [Overview](https://developer.swoogo.com/api-reference/overviews/event-badges.md): Manage badge templates and generate badge PDFs for registrant check-in - [Overview](https://developer.swoogo.com/api-reference/overviews/event-fields.md): Manage custom fields that extend the event data model - [Overview](https://developer.swoogo.com/api-reference/overviews/event-folders.md): View folders used to organize events in the Swoogo dashboard - [Overview](https://developer.swoogo.com/api-reference/overviews/event-questions.md): View questions configured on event registration forms - [Overview](https://developer.swoogo.com/api-reference/overviews/event-websites.md): View websites associated with events - [Overview](https://developer.swoogo.com/api-reference/overviews/events.md): The top-level resource in Swoogo — conferences, meetings, webinars, and more - [Overview](https://developer.swoogo.com/api-reference/overviews/images.md): Upload, retrieve, and delete images for registrants, speakers, sponsors, and more - [Overview](https://developer.swoogo.com/api-reference/overviews/invitation-lists.md): Curated groups of contacts for targeted event invitations - [Overview](https://developer.swoogo.com/api-reference/overviews/package-fees.md): Manage pricing tiers for registration packages - [Overview](https://developer.swoogo.com/api-reference/overviews/packages.md): Pricing tiers for event registration - [Overview](https://developer.swoogo.com/api-reference/overviews/pages.md): View pages associated with event websites - [Overview](https://developer.swoogo.com/api-reference/overviews/registrant-groups.md): Manage group registration assignments for registrants - [Overview](https://developer.swoogo.com/api-reference/overviews/registrant-line-items.md): View itemized financial data and audit trails for registrant orders - [Overview](https://developer.swoogo.com/api-reference/overviews/registrant-session-waitlists.md): Manage waitlist entries for sessions at capacity - [Overview](https://developer.swoogo.com/api-reference/overviews/registrant-sessions.md): Manage which sessions a registrant is enrolled in - [Overview](https://developer.swoogo.com/api-reference/overviews/registrant-types.md): Manage registration type categories for event attendees - [Overview](https://developer.swoogo.com/api-reference/overviews/registrants.md): Individuals registered for an event — manage registrations, check-ins, sessions, and payments - [Overview](https://developer.swoogo.com/api-reference/overviews/session-attendance.md): Track and manage session attendance records - [Overview](https://developer.swoogo.com/api-reference/overviews/session-fees.md): Manage pricing for individual sessions - [Overview](https://developer.swoogo.com/api-reference/overviews/session-fields.md): Manage custom fields that extend the session data model - [Overview](https://developer.swoogo.com/api-reference/overviews/session-locations.md): Manage physical or virtual locations where sessions take place - [Overview](https://developer.swoogo.com/api-reference/overviews/session-scans.md): Record and manage check-in scans for session attendance - [Overview](https://developer.swoogo.com/api-reference/overviews/sessions.md): Individual agenda items within an event — talks, workshops, panels, and breaks - [Overview](https://developer.swoogo.com/api-reference/overviews/speaker-sessions.md): Manage the many-to-many association between speakers and sessions - [Overview](https://developer.swoogo.com/api-reference/overviews/speakers.md): Presenters associated with event sessions - [Overview](https://developer.swoogo.com/api-reference/overviews/sponsor-attendance.md): View sponsor attendance records for events - [Overview](https://developer.swoogo.com/api-reference/overviews/sponsor-fields.md): Manage custom fields that extend the sponsor data model - [Overview](https://developer.swoogo.com/api-reference/overviews/sponsors.md): Organizations or individuals providing support for events - [Overview](https://developer.swoogo.com/api-reference/overviews/tracks.md): Thematic categories that group related sessions - [Overview](https://developer.swoogo.com/api-reference/overviews/transactions.md): Financial activity for registrants — payments, refunds, and credits - [Overview](https://developer.swoogo.com/api-reference/overviews/webhook-groups.md): Organize webhooks into groups for easier management - [Overview](https://developer.swoogo.com/api-reference/overviews/webhooks.md): HTTP callbacks that fire when resources are created, updated, or deleted - [Get package fee configuration](https://developer.swoogo.com/api-reference/package-fees/get-package-fee-configuration.md): Retrieve the current fee configuration for a specific package, including base price and conditional pricing. - [Remove package fee](https://developer.swoogo.com/api-reference/package-fees/remove-package-fee.md): Remove the fee for a specific package, effectively making it free. This sets the base price to 0 and clears all conditional pricing. - [Update package fee configuration](https://developer.swoogo.com/api-reference/package-fees/update-package-fee-configuration.md): Update the fee configuration for a specific package. You can update the base price and/or conditional pricing. - [Create Package](https://developer.swoogo.com/api-reference/packages/create-package.md): Creates a new registration package for an event. Requires `event_id` and `name` in the request body. Optionally set `capacity` to limit the number of registrants who can select this package, and configure `min_group_size`/`max_group_size` for group registration constraints. - [Delete Package](https://developer.swoogo.com/api-reference/packages/delete-package.md): Permanently deletes a registration package by its ID. This will remove the package as a selectable option for future registrations. Existing registrants already assigned to this package are not affected. - [Get All Packages](https://developer.swoogo.com/api-reference/packages/get-all-packages.md): Retrieves all registration packages (pricing tiers) for a specific event. Packages define the pricing structure that registrants select during registration, including capacity limits and group size constraints. Requires the `event_id` query parameter. - [Get One Package](https://developer.swoogo.com/api-reference/packages/get-one-package.md): Retrieves a single registration package by its ID, including name, capacity, group size limits, and sold-out message. Use the `expand` parameter to include related `earlyBirds` pricing tiers.
Extra Fields - [Update Package](https://developer.swoogo.com/api-reference/packages/update-package.md): Updates an existing registration package by its ID. You can modify the package name, capacity, group size limits, display names, and sold-out message. Only the fields included in the request body will be updated. - [Get All Pages](https://developer.swoogo.com/api-reference/pages/get-all-pages.md): Retrieves all pages for a specific event website. Pages represent individual web pages within an event site (e.g., registration page, agenda, speaker directory). Requires the `event_id` query parameter. Read-only endpoint. - [Get One Page](https://developer.swoogo.com/api-reference/pages/get-one-page.md): Retrieves a single event page by its ID, including the page name, slug, full URL, type (e.g., registration, agenda), sort order, and associated website. Read-only endpoint. - [Rate limits](https://developer.swoogo.com/api-reference/rate-limits.md): Understand API rate limiting and how to stay within your quota - [Add Registrant to Group](https://developer.swoogo.com/api-reference/registrant-groups/add-registrant-to-group.md): Adds a registrant to an existing registration group. The target group is identified by `group_id` (which is the primary registrant's ID). Both registrants must belong to the same event. When added, the registrant's transactions and line items are consolidated under the group primary's financial reco… - [Remove Registrant from Group](https://developer.swoogo.com/api-reference/registrant-groups/remove-registrant-from-group.md): Removes a registrant from their current registration group. The registrant becomes their own group primary with an independent financial record. Transactions are restored to the registrant's individual account. The registrant must not be the group primary to be removed. - [Get All Line Item Audits](https://developer.swoogo.com/api-reference/registrant-line-item-audits/get-all-line-item-audits.md): Retrieves the audit trail for registrant line items within an event. Each audit record tracks a historical change to a line item, including price modifications, status changes, and discount applications. Requires the `event_id` query parameter. Useful for financial reconciliation and debugging prici… - [Get All Line Items](https://developer.swoogo.com/api-reference/registrant-line-items/get-all-line-items.md): Retrieves all financial line items for registrants within an event. Line items represent individual charges (packages, sessions, custom fees) on a registrant's invoice, including net/gross amounts, tax rates, and quantities. Requires the `event_id` query parameter. Use `search` to filter by registra… - [Create Session Waitlist Registrant](https://developer.swoogo.com/api-reference/registrant-session-waitlists/create-session-waitlist-registrant.md): Adds a registrant to the waitlist for a sold-out session. Requires both `registrant_id` and `session_id` as path parameters. When a spot opens up in the session, waitlisted registrants can be promoted to confirmed attendees. - [Delete Session Waitlist Registrant](https://developer.swoogo.com/api-reference/registrant-session-waitlists/delete-session-waitlist-registrant.md): Removes a registrant from a session's waitlist. Requires both `registrant_id` and `session_id` as path parameters. The registrant will no longer be in line for a spot if one opens up. - [Create Registrant Session](https://developer.swoogo.com/api-reference/registrant-sessions/create-registrant-session.md): Adds a session to a registrant's selected sessions. Both `registrant_id` and `session_id` are required path parameters. By default, the request will fail if the session is at capacity or has scheduling conflicts. Set `override_capacity_errors` to bypass capacity checks, `send_email` to trigger a ses… - [Delete Registrant Session](https://developer.swoogo.com/api-reference/registrant-sessions/delete-registrant-session.md): Removes a session from a registrant's selected sessions. Requires both `registrant_id` and `session_id` as path parameters. The registrant will no longer appear in the session's attendance list. - [Create Type](https://developer.swoogo.com/api-reference/registrant-types/create-type.md): Creates a new registration type for an event. Requires `event_id` and `name` in the request body. Optionally set `capacity` to limit how many registrants can select this type. - [Delete Type](https://developer.swoogo.com/api-reference/registrant-types/delete-type.md): Permanently deletes a registration type by its ID. The type will no longer be available as a selection for new registrations. Existing registrants already assigned to this type are not affected. - [Get All Types](https://developer.swoogo.com/api-reference/registrant-types/get-all-types.md): Retrieves all registration types for a specific event. Registration types (e.g., Attendee, Exhibitor, Speaker) categorize registrants and can have different pricing, capacity limits, and group size constraints. Requires the `event_id` query parameter. - [Get One Type](https://developer.swoogo.com/api-reference/registrant-types/get-one-type.md): Retrieves a single registration type by its ID, including name, capacity, group size limits, and sold-out message. Use the `expand` parameter to include related `earlyBirds` pricing tiers.
Extra Fields - [Update Type](https://developer.swoogo.com/api-reference/registrant-types/update-type.md): Updates an existing registration type by its ID. You can modify the name, capacity, group size limits, display names, and sold-out message. Only the fields included in the request body will be updated. - [Check Registrant In](https://developer.swoogo.com/api-reference/registrants/check-registrant-in.md): Marks a registrant as checked in (or updates their attendance status) at the event. Sets the `checked_in_at` timestamp and updates the `registration_status` accordingly. - [Create Registrant](https://developer.swoogo.com/api-reference/registrants/create-registrant.md): Creates a new registrant for a specific event. Requires `event_id` and `email` at minimum. Returns the full registrant record on success. - [Create Registrant Token](https://developer.swoogo.com/api-reference/registrants/create-registrant-token.md): Creates a pre-population token that allows registrant details to be pre-filled on a registration form. Returns a token and a ready-to-use resume URL. - [Email Registrant](https://developer.swoogo.com/api-reference/registrants/email-registrant.md): Triggers a transactional email to a registrant. Use this to re-send confirmation emails, send abandoned registration reminders, or notify registrants of modifications or cancellations. - [Get All Registrants](https://developer.swoogo.com/api-reference/registrants/get-all-registrants.md): Retrieves a paginated list of registrants for a specific event. Returns registrant profile data, registration status, and financial summaries. - [Get One Registrant](https://developer.swoogo.com/api-reference/registrants/get-one-registrant.md): Retrieves a single registrant by their unique ID. Returns the full registrant profile including personal details, registration status, financial totals, and session assignments. - [Update Registrant](https://developer.swoogo.com/api-reference/registrants/update-registrant.md): Updates an existing registrant's profile data by their unique ID. Only the fields included in the request body are modified; omitted fields are left unchanged. - [Create Session Attendance](https://developer.swoogo.com/api-reference/session-attendance/create-session-attendance.md): Creates a new attendance record to mark a registrant as having attended a session. Requires `session_id` and `registrant_id` in the request body. This is separate from session registration and represents actual physical attendance. - [Get All Attendance](https://developer.swoogo.com/api-reference/session-attendance/get-all-attendance.md): Retrieves all session attendance records for an event. Each record links a registrant to a session and tracks whether they actually attended (as opposed to just being registered). Requires the `event_id` query parameter. Useful for post-event reporting and CE credit tracking. - [Update Session Attendance](https://developer.swoogo.com/api-reference/session-attendance/update-session-attendance.md): Updates an existing session attendance record by its ID. Use this to modify the attendance status or other details of a previously recorded attendance entry. - [Get session fee configuration](https://developer.swoogo.com/api-reference/session-fees/get-session-fee-configuration.md): Retrieve the current fee configuration for a specific session, including base price and conditional pricing. - [Remove session fee](https://developer.swoogo.com/api-reference/session-fees/remove-session-fee.md): Remove the fee for a specific session, effectively making it free. This sets the base price to 0 and clears all conditional pricing. - [Update session fee configuration](https://developer.swoogo.com/api-reference/session-fees/update-session-fee-configuration.md): Update the fee configuration for a specific session. You can update the base price and/or conditional pricing. - [Create Field](https://developer.swoogo.com/api-reference/session-fields/create-field.md): Creates a new custom field definition for sessions. Specify the field name, type (text, dropdown, checkbox, etc.), visibility, sort order, and choices (for selection-type fields). The field will become available for data entry on all sessions. - [Delete Field](https://developer.swoogo.com/api-reference/session-fields/delete-field.md): Permanently deletes a custom session field definition by its ID. Any data stored in this field on existing sessions will no longer be accessible. - [Get All Fields](https://developer.swoogo.com/api-reference/session-fields/get-all-fields.md): Retrieves all custom field definitions for sessions. These fields define the schema for additional data that can be captured on sessions (e.g., custom text fields, dropdowns, URLs). Each field includes its attribute name, display type, visibility, sort order, and validation requirements. - [Get One Field](https://developer.swoogo.com/api-reference/session-fields/get-one-field.md): Retrieves a single custom session field definition by its ID, including the attribute name, field type, visibility settings, validation rules, and available choices (for dropdown/radio fields). - [Update Field](https://developer.swoogo.com/api-reference/session-fields/update-field.md): Updates an existing custom session field definition by its ID. You can modify the field name, type, visibility, sort order, validation rules, and available choices. - [Create Location](https://developer.swoogo.com/api-reference/session-locations/create-location.md): Creates a new session location (room/venue) for an event. Requires `event_id` and `name` in the request body. Optional fields: `capacity` (max occupancy), `color` (hex code used for display in session calendars), and `use_event_address` (when true, the location reuses the event's address rather than… - [Delete Location](https://developer.swoogo.com/api-reference/session-locations/delete-location.md): Permanently deletes a session location by its ID. Sessions currently assigned to this location will need to be reassigned to a different location. - [Get All Locations](https://developer.swoogo.com/api-reference/session-locations/get-all-locations.md): Retrieves all session locations (rooms/venues) for a specific event. Locations can be assigned to sessions and include details like name, capacity, and address. Requires the `event_id` query parameter. - [Get One Location](https://developer.swoogo.com/api-reference/session-locations/get-one-location.md): Retrieves a single session location by its ID, including the location name, capacity, and address details. - [Update Location](https://developer.swoogo.com/api-reference/session-locations/update-location.md): Updates an existing session location by its ID. You can modify the name, capacity, and address. Only the fields included in the request body will be updated. - [Create Session Scan](https://developer.swoogo.com/api-reference/session-scans/create-session-scan.md): Records a new check-in scan for a registrant at a session. Requires `registrant_id` and `session_id` as path parameters. Use this to programmatically check in attendees at session entrances, equivalent to scanning their badge or QR code. - [Delete Scan](https://developer.swoogo.com/api-reference/session-scans/delete-scan.md): Deletes a session check-in scan record for a specific registrant and session. Use this to reverse an accidental check-in or correct scanning errors. - [Get All Scans](https://developer.swoogo.com/api-reference/session-scans/get-all-scans.md): Retrieves all session check-in scan records for an event. Scans are created when a registrant's badge or QR code is scanned at a session entrance, providing a timestamped record of physical check-in. Requires the `event_id` query parameter. - [Create Session](https://developer.swoogo.com/api-reference/sessions/create-session.md): Creates a new session within an event. Returns the full session record on success. - [Delete Session](https://developer.swoogo.com/api-reference/sessions/delete-session.md): Permanently deletes a session by its unique ID. Returns a `204 No Content` response on success. - [Get All Sessions](https://developer.swoogo.com/api-reference/sessions/get-all-sessions.md): Retrieves a paginated list of sessions for a specific event. Returns session scheduling, capacity, track, and configuration details. - [Get One Session](https://developer.swoogo.com/api-reference/sessions/get-one-session.md): Retrieves a single session by its unique ID. Returns the full session record including name, date, times, capacity, location, track, and status. - [Update Session](https://developer.swoogo.com/api-reference/sessions/update-session.md): Updates an existing session by its unique ID. Only the fields included in the request body are modified; omitted fields are left unchanged. - [Add sessions to speaker (JSON body)](https://developer.swoogo.com/api-reference/speaker-sessions/add-sessions-to-speaker-json-body.md): Assigns a speaker to one or more sessions in a single request using a JSON body with an array of `session_ids`. The speaker is identified by `speaker_id` in the path. All sessions must belong to the same event as the speaker. Returns the full speaker object including the updated sessions list on suc… - [Create Speaker](https://developer.swoogo.com/api-reference/speaker-sessions/create-speaker.md): Assigns a speaker to a single session by providing both `speaker_id` and `session_id` as path parameters. The speaker and session must belong to the same event. Returns the created association. To assign a speaker to multiple sessions at once, use the JSON body variant of this endpoint instead. - [Delete Speaker](https://developer.swoogo.com/api-reference/speaker-sessions/delete-speaker.md): Removes a speaker from a specific session by providing both `speaker_id` and `session_id` as path parameters. This only removes the association -- the speaker and session records themselves are not deleted. - [Create Speaker](https://developer.swoogo.com/api-reference/speakers/create-speaker.md): Creates a new speaker for an event by linking an existing contact. Both `event_id` and `contact_id` are required. The speaker's profile data (name, email, company, bio) is pulled from the linked contact record. Returns the newly created speaker object. Note that speakers cannot be updated via PUT --… - [Delete Speaker](https://developer.swoogo.com/api-reference/speakers/delete-speaker.md): Permanently removes a speaker from an event by `speaker_id`. This also removes any session associations for the speaker. The underlying contact record is not affected. Note that there is no PUT endpoint for speakers -- to modify speaker data, update the linked contact record directly. - [Get All Speakers](https://developer.swoogo.com/api-reference/speakers/get-all-speakers.md): Returns a paginated list of speakers for a specific event. Requires the `event_id` query parameter. Default fields returned are `id`, `first_name`, and `last_name` -- use `fields` to request additional properties and `expand=sessions` to include each speaker's assigned sessions. Use `search` to filt… - [Get One Speaker](https://developer.swoogo.com/api-reference/speakers/get-one-speaker.md): Returns the full details of a single speaker by `speaker_id`. Use `fields` to limit which properties are returned and `expand=sessions` to include the list of sessions assigned to this speaker. Speaker profile data (name, email, company, bio) originates from the linked contact record. - [Get All Attendance](https://developer.swoogo.com/api-reference/sponsor-attendance/get-all-attendance.md): Returns a paginated list of sponsor attendance records for a specific event. Requires the `event_id` query parameter. Each record tracks a sponsor's participation or booth presence at the event. Use `search` to filter results and `fields` to limit which properties are returned. - [Create Field](https://developer.swoogo.com/api-reference/sponsor-fields/create-field.md): Creates a new custom field definition for sponsors. Requires `name` and `type` (e.g., textInput, dropDownList, textArea). For choice-based types, include a `choices` array. Optional properties include sort order, visibility, required flag, and HTML settings. Returns the newly created field definitio… - [Delete Field](https://developer.swoogo.com/api-reference/sponsor-fields/delete-field.md): Permanently deletes a sponsor custom field definition by `field_id`. This removes the field schema and all stored values for this field across all sponsors. This action cannot be undone. - [Get All Fields](https://developer.swoogo.com/api-reference/sponsor-fields/get-all-fields.md): Returns a paginated list of custom field definitions available for sponsors. These define the schema for custom data that can be stored on sponsor records (e.g., sponsorship level, booth number). Each field includes its type, name, sort order, visibility, and choices (for dropdown/multi-select field… - [Get One Field](https://developer.swoogo.com/api-reference/sponsor-fields/get-one-field.md): Returns the full details of a single sponsor custom field definition by `field_id`, including its type, name, attribute key, sort order, visibility, required flag, and available choices (for dropdown or multi-select fields). - [Update Field](https://developer.swoogo.com/api-reference/sponsor-fields/update-field.md): Updates an existing sponsor custom field definition by `field_id`. Send only the properties you want to change. For choice-based fields, you can add new choices, update existing choices by `id`, or delete choices by passing `delete: true` with the choice `id`. Returns the full updated field definiti… - [Create Sponsor](https://developer.swoogo.com/api-reference/sponsors/create-sponsor.md): Creates a new sponsor for an event. Both `event_id` and `name` are required. You can also set optional fields such as website, description, level, and logo_id. Returns the newly created sponsor object. - [Delete Sponsor](https://developer.swoogo.com/api-reference/sponsors/delete-sponsor.md): Permanently deletes a sponsor from an event by `sponsor_id`. This also removes any sponsor attendance records and custom field values associated with the sponsor. This action cannot be undone. - [Get All Sponsors](https://developer.swoogo.com/api-reference/sponsors/get-all-sponsors.md): Returns a paginated list of sponsors for a specific event. Requires the `event_id` query parameter. Default fields returned are `id` and `name` -- use `fields` to request additional properties such as website, description, level, logo_id, and direct_link. Use `search` to filter by any sponsor field… - [Get One Sponsor](https://developer.swoogo.com/api-reference/sponsors/get-one-sponsor.md): Returns the full details of a single sponsor by `sponsor_id`, including name, description, level, website, logo, and direct link. Use `fields` to limit which properties are returned. - [Update One Sponsor](https://developer.swoogo.com/api-reference/sponsors/update-one-sponsor.md): Updates an existing sponsor by `sponsor_id`. Send only the fields you want to change -- any omitted fields retain their current values. Updatable fields include name, website, description, level, logo_id, and notes. Returns the full updated sponsor object. - [Create Track](https://developer.swoogo.com/api-reference/tracks/create-track.md): Creates a new session track for an event. Requires `event_id` and `name` in the request body. Once created, sessions can be assigned to this track to categorize the event agenda. - [Delete Track](https://developer.swoogo.com/api-reference/tracks/delete-track.md): Permanently deletes a session track by its ID. Sessions currently assigned to this track will need to be reassigned or will lose their track categorization. - [Get All Tracks](https://developer.swoogo.com/api-reference/tracks/get-all-tracks.md): Retrieves all tracks for a specific event. Tracks are thematic categories used to organize sessions (e.g., "Technical", "Business", "Workshop"). Requires the `event_id` query parameter. Sessions can be assigned to tracks to help attendees filter and navigate the agenda. - [Get One Track](https://developer.swoogo.com/api-reference/tracks/get-one-track.md): Retrieves a single session track by its ID, including the track name, color, and description. - [Update Track](https://developer.swoogo.com/api-reference/tracks/update-track.md): Updates an existing session track by its ID. You can modify the track name, color, and description. - [Create Transaction](https://developer.swoogo.com/api-reference/transactions/create-transaction.md): Creates an offline transaction record for a registrant. Use this for payments or refunds processed outside the online payment gateway (e.g., wire transfers, checks, cash). Requires `event_id`, `registrant_id`, `type`, and `amount`. The `type` must be an offline payment or refund type such as `wire_t… - [Delete Transaction](https://developer.swoogo.com/api-reference/transactions/delete-transaction.md): Permanently deletes a transaction record by its ID. This removes the financial record from the registrant's payment history and may affect their payment status and balance due calculations. - [Get All Transactions](https://developer.swoogo.com/api-reference/transactions/get-all-transactions.md): Retrieves all financial transaction records for a specific event. Transactions include payments, refunds, and credits linked to registrants. Requires the `event_id` query parameter. Each record contains the amount, type (e.g., credit_card_payment, wire_transfer_refund), status, and associated regist… - [Get One Transaction](https://developer.swoogo.com/api-reference/transactions/get-one-transaction.md): Retrieves a single transaction by its ID, including payment details (amount, type, status), card information (last 4 digits, card type), associated registrant, and payment gateway used. - [Create Webhook Group](https://developer.swoogo.com/api-reference/webhook-groups/create-webhook-group.md): Creates a new webhook group. Specify the group name and assign it to one or more events. After creating the group, use the Create Webhook endpoint to add individual webhook configurations to it. - [Delete Webhook Group](https://developer.swoogo.com/api-reference/webhook-groups/delete-webhook-group.md): Permanently deletes a webhook group and all webhooks it contains. All HTTP callbacks from webhooks in this group will immediately stop firing. - [Get All Webhook Groups](https://developer.swoogo.com/api-reference/webhook-groups/get-all-webhook-groups.md): Retrieves all webhook groups. Webhook groups organize individual webhooks and control which events they apply to. A group is assigned to one or more events, and all webhooks within the group will fire for those events. This allows you to manage webhook configurations across multiple events centrally… - [Get One Webhook Group](https://developer.swoogo.com/api-reference/webhook-groups/get-one-webhook-group.md): Retrieves a single webhook group by its ID, including the group name, associated event IDs, and the list of webhooks it contains. - [Update Webhook Group](https://developer.swoogo.com/api-reference/webhook-groups/update-webhook-group.md): Updates an existing webhook group by its ID. You can modify the group name and the list of events it applies to. - [Create Webhook](https://developer.swoogo.com/api-reference/webhooks/create-webhook.md): Creates a new webhook configuration. Specify the target URL, trigger event type, HTTP method, and optional custom headers. The webhook must be assigned to a webhook group, which controls which events it applies to. - [Delete Webhook](https://developer.swoogo.com/api-reference/webhooks/delete-webhook.md): Permanently deletes a webhook configuration by its ID. The webhook will immediately stop sending HTTP callbacks for its trigger event type. - [Get All Webhooks](https://developer.swoogo.com/api-reference/webhooks/get-all-webhooks.md): Retrieves all webhook configurations. Webhooks send HTTP POST callbacks to your specified URL when events occur in Swoogo (e.g., new registration, session check-in, payment received). Each webhook defines the target URL, trigger event type, and which webhook group it belongs to.