Loading documentation…
{{ error }}
Permissions
Understand organizer, company, and event access for integrations.
Organizer API access follows the account’s existing Paydro rights. Authentication establishes the account; authorization determines which company/event data it can read and change. File and customer document bearer downloads are described separately in Files.
Organization membership
Ask your organization administrator to give the integration account the appropriate organizer role. Use the correct company hostname when working with a specific organization. A UUID identifies a record; possession of the identifier does not grant access to it.
Event access
Event scoped requests check the event against the current account. List resources may use the account’s accessible companies, while event discovery applies a live company membership check. As a result, an event list and a bulk response may have different scopes. Use explicit event scoped reads when you need a single event.
Account lifecycle
Inactive or deleted accounts cannot authenticate. Company membership and event roles can change after an integration is deployed. When requests start failing, check the account and its rights before retrying repeatedly.
Operation permissions
Company membership types are 0 (sales), 1 (manager) and 2 (administrator). Event access generally checks active company membership rather than a distinct API scope. Additional checks below are enforced by the operation; an organizer button's visibility does not create an API permission boundary.
| Operations | Required access | Additional restrictions |
|---|---|---|
| Event, product, category/question, order, attendee, waiting-list, promo-code and traffic reads; event exports | Active organizer with access to the event's company. | Individual ownership, filters and resource availability still apply. Discovery and bulk reads can have narrower company/date scopes. |
| Event creation, editing, duplication and shop-status changes | Company manager or administrator (type ≥ 1). | Use the requested company host; dates, sales state and company clearance can block a change. |
| Product, category and question writes | Active organizer with event access. | Same-event categories/package members, provider configuration, used products, protected categories and question eligibility are checked. These controllers do not add an editor-type requirement to every published write. |
| Order and attendee edits/actions | Active organizer with event access. | Current payment/lifecycle capabilities decide whether editing, cancellation or a reservation action is allowed; archived paid options remain protected. |
| Waiting-list invitations/settings/removal; event promo-code writes/invitations | Active organizer with event access. | Entry/product/code ownership, invitation limits and referenced-code rules apply. |
| Add organizer notes | Active organizer with rights to the note's parent event. | Parent must be Event, Order or OrderLine; text is 2–500 characters after trimming. |
| Edit organizer notes | The note's author, still authorized for its event. | Only within 15 minutes of creation; text is the writable field. |
| Bulk event-note reads; organizer/company directories | Active organizer; membership-scoped records. | Bulk notes include Event parents only. An administrator override on one event read does not imply an unbounded company directory. |
| Check-in and scan removal | Authorized organizer; scanning also accepts an established scoped check-in session. | A raw access code is not a Basic credential. Use the existing check-in exchange; ticket/event ownership is checked. |
| Event attachment upload/removal | Company administrator (type 2). | Existing file size/type/storage and attachment ownership rules apply. Multipart upload uses POST. |
| Stage state writes | Company manager or administrator (type ≥ 1). | Stage ID and event ID must match; a new default stage uses the event UUID. |
| Stage state reads/SSE; generated bearer document downloads | Public stage URL or possession of the document's bearer URL. | These explicit exceptions do not require organizer Basic. Treat bearer documents as private links; stage state must contain public display data. |
Platform administrator overrides exist in common authorization, but several actions also perform their own membership/capability checks. Use a normal company account with the required rights to verify your integration. See API coverage for company promo forms, imports and refunds that remain organizer workflows.
Handle access failures
Expect a permission error or legacy JSON error for inaccessible or missing events. Check the status, content type, and body. Do not follow a redirect and treat the resulting login page as event data.
There are no documented API token scopes in this integration surface. Grant the account the minimum organizer rights that your workflow needs, and verify both an authorized request and an inaccessible event in your test environment.