Documentation for Rezdy “next-tours” API

next-tours returns information about upcoming scheduled bookings for a product in Rezdy

Read more about our next-tours API call. If you want to be notified about changes to this documentation, then please let us know via our contact page and we’ll email you every time it changes.

Please suggest any changes or enhancements to this call by commenting below. Thank you!

Swagger Documentation

{
  "swagger": "2.0",
  "info": {
    "version": "2019-07-23T07:20:31Z",
    "title": "rezdy"
  },
  "host": "rezdy.api.align.com.au",
  "basePath": "/v1",
  "schemes": [
    "https"
  ],
  "paths": {
    "/next-tours": {
      "get": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "Rezdy-API-Key",
            "in": "header",
            "required": true,
            "type": "string"
          },
          {
            "name": "timezone",
            "in": "query",
            "description": "REQUIRED: Timezone used to format the date.
             e.g. Australia/Perth. See 
             https://www.php.net/manual/en/timezones.php.",
            "required": true,
            "type": "string"
          },
          {
            "name": "X-API-Key",
            "in": "header",
            "description": "REQUIRED: API Key issued by Align Systems.",
            "required": true,
            "type": "string"
          },
          {
            "name": "product_codes",
            "in": "query",
            "description": "REQUIRED: Comma delimited list of Rezdy product codes
             e.g. PHWQ1A,PX3GS1",
            "required": true,
            "type": "string"
          },
          {
            "name": "num_tours",
            "in": "query",
            "description": "Number of tours to return. Default is 1.",
            "required": false,
            "type": "string"
          },
          {
            "name": "only_booked",
            "in": "query",
            "description": "1 - only return booked tours,
             0 (Default) to return any scheduled tour.",
            "required": false,
            "type": "string"
          },
          {
            "name": "days",
            "in": "query",
            "description": "Number of days ahead to look. Default is 5.",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "200 response",
            "schema": {
              "$ref": "#/definitions/Empty"
            }
          }
        }
      }
    }
  },
  "securityDefinitions": {
    "api_key": {
      "type": "apiKey",
      "name": "x-api-key",
      "in": "header"
    }
  },
  "definitions": {
    "Empty": {
      "type": "object",
      "title": "Empty Schema"
    }
  },
  "x-amazon-apigateway-documentation": {
    "version": "5",
    "createdDate": "2019-07-24T06:53:51Z",
    "documentationParts": [
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/next-tours",
          "method": "GET",
          "name": "days"
        },
        "properties": {
          "description": "Number of days ahead to look. Default is 5."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/next-tours",
          "method": "GET",
          "name": "num_tours"
        },
        "properties": {
          "description": "Number of tours to return. Default is 1."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/next-tours",
          "method": "GET",
          "name": "only_booked"
        },
        "properties": {
          "description": "1 - only return booked tours,
0 (Default) to return any scheduled tour."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/next-tours",
          "method": "GET",
          "name": "product_codes"
        },
        "properties": {
          "description": "REQUIRED: Comma delimited list of Rezdy product codes
           e.g. PHWQ1A,PX3GS1"
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/next-tours",
          "method": "GET",
          "name": "timezone"
        },
        "properties": {
          "description": "REQUIRED: Timezone used to format the date.
           e.g. Australia/Perth.
           See https://www.php.net/manual/en/timezones.php."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/next-tours",
          "method": "GET",
          "name": "X-API-Key"
        },
        "properties": {
          "description": "REQUIRED: API Key issued by Align Systems."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/next-tours",
          "method": "GET",
          "name": "rezdy_API_key"
        },
        "properties": {
          "description": "REQUIRED: Rezdy API Key. In the Rezdy web application,
           click on Integrations then Rezdy API."
        }
      },
      {
        "location": {
          "type": "RESPONSE_BODY",
          "path": "/next-tours",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "status": "string=success|error",
          "summary": "string",
          "num_sessions": "int32",
          "sessions": [
            {
              "allDay": "boolean",
              "endTime": "date-time",
              "endTimeLocal": "string",
              "id": "int64",
              "priceOptions": [
                {
                  "id": "int64",
                  "label": "string",
                  "maxQuantity": "int32",
                  "minQuantity": "int32",
                  "price": "float",
                  "priceGroupType": "string",
                  "productCode": "string",
                  "seatsUsed": "int32"
                }
              ],
              "productCode": "string",
              "seats": "int32",
              "seatsAvailable": "int32",
              "startTime": "date-time",
              "startTimeLocal": "string"
            }
          ]
        }
      }
    ]
  }
}