Changelog

8 May 2024

• Remove registration.started webhook.

16 April 2024

• Fix incorrect JSON in the webhook payloads example.

4 Jan 2024

• Add :show_public_releases, :show_secret_releases, :block_registrations_if_not_applicable attributes to discount codes API v3.1.

28 Sept 2023

• The :reminder ticket :state is dropped in the v3 Admin API.

29 May 2023

• Add sections for new <tito-register-interest> and <tito-events> widgets.

18 April 2023

• Add development_mode plugin to widget docs.

14 Jul 2023

• Enable test mode with a plugin instead of a API key.

8 Feb 2023

• Add docs about the ga4 plugin

14 Sept 2022

• Add the waitlisted people API docs.

5 April 2022

We've released version 3.1 of our Admin API in beta.

The aim of version 3.1 is simplicity and speed.

No nested resources by default

In version 3.0, if you asked for a registration then you got all its tickets too (as well line_items, payment, receipt, receipts, and refunds). But if you don't need all those other resources then it just makes the response bigger and slower. In version 3.1 you just get the resource you asked for unless you explicitly "expand" other resources.

For example, to get a single registration:

https://api.tito.io/v3/:account/:event/registrations/:slug

To get its tickets too:

https://api.tito.io/v3/:account/:event/registrations/:slug?expand=tickets

You can expand multiple resources:

https://api.tito.io/v3/:account/:event/registrations/:slug?expand=tickets,receipts

Same view

In version 3.0, you got an "extended" view of a resource if you asked for a single resource and a "short" view of a resource if you asked for a list. In version 3.1, you get the same view regardless. The view option has been replaced with the more flexible expand option.

Choosing a version

You can choose which version you want to use in two ways:

• Set your access token to a specific version
• Send a version parameter in the URL

For example:

https://api.tito.io/v3/:account/:event/registrations/:slug?version=3.1

The URL setting will override the access token setting.

Using id and slug

In version 3.0 we had attributes like release_ids that would actually return you an array of slugs. Now, if you ask for ids you get integers as you would expect. Where possible, we also offer the slugs too, e.g. release_slugs.

Meta data

In version 3.0, we attached a meta attribute to every list. In version 3.1, all responses include it. Some additional information is also added to it:

• api_version
• expandable — a list of possible expansions for this resource and whether they are expanded or not.

If you try and use the view parameter or if you choose an expansion that is not available, then you will also see a warning attribute that tells you about that.

For example:

{
    "ticket": {
        "_type": "ticket",
        "id": 123,
        ...
        "registration": {
          "_type": "registration",
          "id": 106,
          ...
        }
      }
    },
    "meta": {
        "api_version": "3.1.0",
        "expandable": {
            "activities": false,
            "answers": false,
            "opt_ins": false,
            "registration": true,
            "release": false,
            "responses": false
        }
    }
}

28th September 2023

Updated

• Admin API v3.1: The reminder ticket state has been replaced by unassigned.

17th September 2021

Added

• Widget V2 documentation for using PayPal Platform

12th August 2021

Added

• Opt-Ins documentation

10th June 2021

Added

• Widget V2 documentation

21st May 2021

Removed

• Remove reference to the registration filling state and webhook trigger. GDPR doesn't allow us to gather that information without express permission.

2nd March 2021

Added

• Add documentation for setting custom name/email placeholders on v2 widget.

1st March 2021

Added

• Add authorization error documentation.

3rd December 2019

Updated

• Release endpoints have deprecated payment_type in favour of the new pricing_type attribute which is not read-only. To change the pricing type set it to either free, paid, donation or degressive.

4th September 2019

Added

• Add Webhook Endpoint API docs
• Add Headers section to specify which headers are required to be sent with requests.

19th August 2019

Added

• Added Webhook JSON payloads for checkin.* webhook types.

5th August 2019

Added

• Added Webhook JSON payloads for ticket.* and registration.* webhook types.

31st July 2019

Added

• Added docs for receiving webhooks from Tito to your local development environment.

6th March 2019

Modified

When we return the metadata for an event, release, registration or ticket we now return an object rather than a JSON string. So instead of seeing "metadata": "{\"foo\":\"bar\"}" you will see "metadata":{"foo":"bar"}".

29th January 2019

Modified

• Creating a registration with this endpoint no longer sends out emails unless you pass in notify = true.

28th January 2019

Added

• Endpoint to create registrations.

17th December 2018

Added

• Placeholder for Checkout API

Modified

• API Docs overview

12th Dec 2018

Added

• Allow past and archived events to be retrieved.

4th Dec 2018

Added

• Docs added for the Tito Checkin API allowing developers to customize the check-in workflow for events.

23rd Nov 2018

Added

• Allow a Release to be made public or secret.

22nd Nov 2018

Added

• Allow a Release to be archived and unarchived.
• Allow a Release to be duplicated.
• Allow an Activity to be duplicated.
• Allow a Release to be put on sale.
• Allow the sale of a release to be paused.

20th Nov 2018

Added

• Allow API developers to regenerate their API Token for the Admin API.