{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cvent REST APIs — Event Cloud Appointments API",
    "version": "ea"
  },
  "items": [
    {
      "info": {
        "name": "Appointments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Appt Attendees",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/appointment-attendees",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Used to query records that have been added or updated after this time point. Default to the beginning of time of the data store."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Used to query records that have been added or updated before this time point."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of records to return per page."
              },
              {
                "name": "token",
                "value": "",
                "type": "query",
                "description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A filter query string narrows search results and supports the combination of logical and comparison operators. The filter adheres to the pattern filter='field' comparisonType 'value'.\n\nThere are six comparison types that can be used in filter expressions:\n* equal: eq\n* not equal: ne\n* greater than: gt\n* greater or equal: ge\n* less than: lt\n* less than or equal: le\n\nThe following fields are filterable:\n* appointmentEvent.id (eq)\n* contact.id (eq)\n* deleted (eq)\n\nThe following operators are available:\n* and"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets a paginated list of appointment attendees."
        },
        {
          "info": {
            "name": "Get Appt Attendee",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/appointment-attendees/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of an appointment attendee. The appointment attendee's ID is a combination of the associated appointment event ID and the attendee's contact ID, concatenated with \"::\" symbols."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets a single appointment attendee by their ID."
        },
        {
          "info": {
            "name": "List Availability",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/appointment-availability-times",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Used to query records that have been added or updated after this time point. Default to the beginning of time of the data store."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Used to query records that have been added or updated before this time point."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of records to return per page."
              },
              {
                "name": "token",
                "value": "",
                "type": "query",
                "description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A filter query string narrows search results and supports the combination of logical and comparison operators. The filter adheres to the pattern filter='field' comparisonType 'value'.\n\nThere are six comparison types that can be used in filter expressions:\n* equal: eq\n* not equal: ne\n* greater than: gt\n* greater or equal: ge\n* less than: lt\n* less than or equal: le\n\nThe following fields are filterable:\n* appointmentEvent.id (eq)\n* attendee.id (eq)\n\nNo operators are available"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets a paginated list of appointment availability times."
        },
        {
          "info": {
            "name": "Get Availability",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/appointment-availability-times/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of an attendee's availability times in a particular event. The attendee's availability times ID is a combination of the associated appointment event ID and the attendee's contact ID, concatenated with \"::\" symbols."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get a single appointment availability time by its ID."
        },
        {
          "info": {
            "name": "List Appt Events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/appointment-events",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Used to query records that have been added or updated after this time point. Default to the beginning of time of the data store."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Used to query records that have been added or updated before this time point."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of records to return per page."
              },
              {
                "name": "token",
                "value": "",
                "type": "query",
                "description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A filter query string narrows search results and supports the combination of logical and comparison operators. The filter adheres to the pattern filter='field' comparisonType 'value'.\n\nThere are six comparison types that can be used in filter expressions:\n* equal: eq\n* not equal: ne\n* greater than: gt\n* greater or equal: ge\n* less than: lt\n* less than or equal: le\n\nThe following fields are filterable:\n* event.id (eq)\n\nNo operators are available"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets a paginated list of appointment events."
        },
        {
          "info": {
            "name": "Get Appt Event",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/appointment-events/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of an appointment event."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets a single appointment event by its ID."
        },
        {
          "info": {
            "name": "List Available Times",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/appointment-events/:id/appointment-available-times",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of an appointment event."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of records to return per page."
              },
              {
                "name": "token",
                "value": "",
                "type": "query",
                "description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A filter query string narrows search results and supports the combination of logical and comparison operators. The filter adheres to the pattern filter='field' comparisonType 'value'.\n\nThere are six comparison types that can be used in filter expressions:\n* equal: eq\n* not equal: ne\n* greater than: gt\n* greater or equal: ge\n* less than: lt\n* less than or equal: le\n\nThe following fields are filterable:\n* appointmentType.id (eq)\n* location.id (eq)\n\nNo operators are available"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets a paginated list of times and locations available for scheduling appointments in a particular appointment event."
        },
        {
          "info": {
            "name": "List Appointment Types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/appointment-events/:id/appointment-types",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of an appointment event."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of records to return per page."
              },
              {
                "name": "token",
                "value": "",
                "type": "query",
                "description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets a paginated list of appointment types for an appointment event."
        },
        {
          "info": {
            "name": "Create Appointment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-platform.cvent.com/ea/appointment-events/:id/appointments",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of an appointment event."
              },
              {
                "name": "suppressNotifications",
                "value": "",
                "type": "query",
                "description": "Flag to choose whether to suppress notifications on successful completion of operation.\n* If flag = false (default), send all notifications as configured.\n * If flag = true, do not send any notification."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Creates an appointment in a given appointment event."
        },
        {
          "info": {
            "name": "Update Appointments",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-platform.cvent.com/ea/appointment-events/:id/appointments/:apptId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of an appointment event."
              },
              {
                "name": "apptId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of an appointment."
              },
              {
                "name": "suppressNotifications",
                "value": "",
                "type": "query",
                "description": "Flag to choose whether to suppress notifications on successful completion of operation.\n* If flag = false (default), send all notifications as configured.\n * If flag = true, do not send any notification."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Updates an appointment based on the given ID."
        },
        {
          "info": {
            "name": "Cancel Appointment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-platform.cvent.com/ea/appointment-events/:id/appointments/:apptId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of an appointment event."
              },
              {
                "name": "apptId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of an appointment."
              },
              {
                "name": "suppressNotifications",
                "value": "",
                "type": "query",
                "description": "Flag to choose whether to suppress notifications on successful completion of operation.\n* If flag = false (default), send all notifications as configured.\n * If flag = true, do not send any notification."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Cancels an appointment with the given appointment ID."
        },
        {
          "info": {
            "name": "List Locations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/appointment-events/:id/locations",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of an appointment event."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of records to return per page."
              },
              {
                "name": "token",
                "value": "",
                "type": "query",
                "description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets a paginated list of appointment locations in a particular appointment event."
        },
        {
          "info": {
            "name": "List Interests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/appointment-meeting-interests",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Used to query records that have been added or updated after this time point. Default to the beginning of time of the data store."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Used to query records that have been added or updated before this time point."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of records to return per page."
              },
              {
                "name": "token",
                "value": "",
                "type": "query",
                "description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A filter query string narrows search results and supports the combination of logical and comparison operators. The filter adheres to the pattern filter='field' comparisonType 'value'.\n\nThere are six comparison types that can be used in filter expressions:\n* equal: eq\n* not equal: ne\n* greater than: gt\n* greater or equal: ge\n* less than: lt\n* less than or equal: le\n\nThe following fields are filterable:\n* appointmentEvent.id (eq)\n* attendee.id (eq)\n\nNo operators are available"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets a paginated list of appointment meeting interests."
        },
        {
          "info": {
            "name": "Get Interest",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/appointment-meeting-interests/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of an attendee's meeting interests in a particular event. The attendee's meeting interests ID is a combination of the associated appointment event ID and the attendee's contact ID, concatenated with \"::\" symbols."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets a single attendee's meeting interests in a particular appointment event by their interest ID."
        },
        {
          "info": {
            "name": "List Appointments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/appointments",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Used to query records that have been added or updated after this time point. Default to the beginning of time of the data store."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Used to query records that have been added or updated before this time point."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of records to return per page."
              },
              {
                "name": "token",
                "value": "",
                "type": "query",
                "description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A filter query string narrows search results and supports the combination of logical and comparison operators. The filter adheres to the pattern filter='field' comparisonType 'value'.\n\nThere are six comparison types that can be used in filter expressions:\n* equal: eq\n* not equal: ne\n* greater than: gt\n* greater or equal: ge\n* less than: lt\n* less than or equal: le\n\nThe following fields are filterable:\n* appointmentEvent.id (eq)\n* participants.attendee.contact.id (eq)\n* code (eq)\n\nNo operators are available"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets a paginated list of appointments."
        },
        {
          "info": {
            "name": "Get Appointment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/appointments/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of an appointment."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets a single appointment by its ID."
        }
      ]
    }
  ],
  "bundled": true
}