REST API

Overview

REST API v2 changelog, base URLs, rate limiting, and getting started.

Changelog

v2

  • Collection endpoints now return records in a top level data key, with a meta key with pagination details and links.
  • Standardized request parameters for sorting, filtering, paging, and including relationships and fields.
  • List all endpoints have a different response format (pagination details is included), and is more performant.
  • Fields that represent money are now returned in a different format: an object with three keys: amount (in cents as an integer), decimal (string type), and formatted (includes currency symbol and delimiters).
  • Ticket tier has been renamed to Registration type.
  • guest_id has changed to contact_id. Contact ID is different than Guest ID, it is a company-specific ID for that user.

Getting started

Tooling

Postman is a great app for testing and experimenting with our API. You can download it here: https://www.getpostman.com/

Base URL

Api Version URL
Latest (v2) https://app.guestmanager.com/api/public
v2 https://app.guestmanager.com/api/public/v2

Versioning

The version is specified in the request URL. If the version is omitted, the latest version will be used by default.

Rate limiting

API requests are throttled by IP address and limited to 300 requests per 1 minute period. If you need to handle more, please contact support. The Retry-After header will specify when you can continue making requests.

Requests

Headers

The following headers must be specified in all API requests.

Header Value
Authorization Token abcdefg
Content-Type application/json
Accept application/json

Parameters

All parameters should be submitted as JSON, however url-encoded data is also suitable. Provide only the attributes that you wish to change — do not submit the entire object, as you will likely encounter an error due to read-only attributes.

Responses

All responses are returned as JSON, along with a relevant status code. If the status code returned is in the 2xx range, you may assume the request succeeded. Therefore, rather than check if the JSON response has an error, always check the status code instead.

Successful status codes

Code Description
200 OK
201 Created
204 No Content — used for DELETE requests.
On this page