# Pexip Engage REST API OpenAPI file: https://developer.pexipengage.com/source.json ## Description This is version `11.0.1` of this API documentation. Last update on Oct 20, 2026. This document describes the specification of the Pexip Engage REST API, hereafter referenced as 'the API'. This contains a description of the functionality that is made available by the API, as well as the architectural style it should use and the protocol by which it is offered. When there is room for interpretation in any of these aspects, this document also tries to specify how the API must resolve these ambiguities. We do this to provide a reference document, both to the implementers and the consumers of the API, and to ensure there is a unified interface that all parties must adhere to and can rely on for their own use. ## Servers - https://api.development.pexipengage.com/enterprises/acme: https://api.development.pexipengage.com/enterprises/acme () ## Topics ### [Authentication](https://developer.pexipengage.com/authentication.md) ### [Registering an application](https://developer.pexipengage.com/topic/topic-registering-an-application.md) ### [Requests and responses](https://developer.pexipengage.com/topic/topic-requests-and-responses.md) ### [Languages & translations](https://developer.pexipengage.com/topic/topic-languages-translations.md) ### [Countries](https://developer.pexipengage.com/topic/topic-countries.md) ### [Dates & time](https://developer.pexipengage.com/topic/topic-dates-time.md) ### [Collection resource properties](https://developer.pexipengage.com/topic/topic-collection-resource-properties.md) ### [Pagination](https://developer.pexipengage.com/topic/topic-pagination.md) ### [Eventual consistency](https://developer.pexipengage.com/topic/topic-eventual-consistency.md) ### [Rate limiting](https://developer.pexipengage.com/topic/topic-rate-limiting.md) ### [File uploading](https://developer.pexipengage.com/topic/topic-file-uploading.md) ### [Error codes](https://developer.pexipengage.com/topic/topic-error-codes.md) ### [Provisioning](https://developer.pexipengage.com/topic/topic-provisioning.md) ### [Webhooks](https://developer.pexipengage.com/topic/topic-webhooks.md) ### [Compression](https://developer.pexipengage.com/topic/topic-compression.md) ### [API upgrades](https://developer.pexipengage.com/topic/topic-api-upgrades.md) ### [Migrating from the legacy API](https://developer.pexipengage.com/topic/topic-migrating-from-the-legacy-api.md) ## Endpoints ### [Appointments](https://developer.pexipengage.com/group/endpoint-appointments.md) - [Get appointments](https://developer.pexipengage.com/operation/operation-getappointments.md) - [Create an appointment](https://developer.pexipengage.com/operation/operation-createappointment.md) - [Get an appointment](https://developer.pexipengage.com/operation/operation-getappointmentbyid.md) - [Update an appointment](https://developer.pexipengage.com/operation/operation-updateappointmentbyid.md) - [Create an appointment invite](https://developer.pexipengage.com/operation/operation-createappointmentinvite.md) - [Accept an appointment](https://developer.pexipengage.com/operation/operation-acceptappointment.md) - [Cancel an appointment](https://developer.pexipengage.com/operation/operation-cancelappointment.md) - [Complete an appointment](https://developer.pexipengage.com/operation/operation-completeappointment.md) - [Reassign an appointment](https://developer.pexipengage.com/operation/operation-reassignappointment.md) - [Reopen an appointment](https://developer.pexipengage.com/operation/operation-reopenappointment.md) - [Request an appointment reschedule](https://developer.pexipengage.com/operation/operation-requestrescheduleappointment.md) - [Reschedule an appointment](https://developer.pexipengage.com/operation/operation-rescheduleappointment.md) - [Update the location of an ON_LOCATION appointment](https://developer.pexipengage.com/operation/operation-updateappointmentlocation.md) - [Update the meeting type of an appointment](https://developer.pexipengage.com/operation/operation-updateappointmentmeetingtype.md) - [Update appointment details](https://developer.pexipengage.com/operation/operation-updateappointmentdetails.md) ### [Calendar event](https://developer.pexipengage.com/group/endpoint-calendar-event.md) - [Add appointment to Google Calendar](https://developer.pexipengage.com/operation/operation-addappointmenttogooglecalendar.md) - [Add appointment to Office365 Calendar](https://developer.pexipengage.com/operation/operation-addappointmenttooffice365calendar.md) - [Download the appointment ICal file](https://developer.pexipengage.com/operation/operation-downloadappointmentical.md) ### [Callback requests](https://developer.pexipengage.com/group/endpoint-callback-requests.md) - [Get callback requests](https://developer.pexipengage.com/operation/operation-getcallbackrequests.md) - [Create a callback request](https://developer.pexipengage.com/operation/operation-createcallbackrequest.md) - [Get a callback request](https://developer.pexipengage.com/operation/operation-getcallbackrequestbyid.md) - [Update a callback request](https://developer.pexipengage.com/operation/operation-updatecallbackrequestbyid.md) ### [Contexts](https://developer.pexipengage.com/group/endpoint-contexts.md) - [Get contexts](https://developer.pexipengage.com/operation/operation-getcontexts.md) - [Create a context](https://developer.pexipengage.com/operation/operation-createcontext.md) - [Resolve a context](https://developer.pexipengage.com/operation/operation-resolvecontext.md) - [Get a context](https://developer.pexipengage.com/operation/operation-getcontextbyid.md) - [Delete a context](https://developer.pexipengage.com/operation/operation-deletecontextbyid.md) - [Update a context](https://developer.pexipengage.com/operation/operation-updatecontextbyid.md) ### [Customers](https://developer.pexipengage.com/group/endpoint-customers.md) - [Get customers](https://developer.pexipengage.com/operation/operation-getcustomers.md) - [Create a customer](https://developer.pexipengage.com/operation/operation-createcustomer.md) - [Get a customer](https://developer.pexipengage.com/operation/operation-getcustomerbyid.md) - [Delete a customer](https://developer.pexipengage.com/operation/operation-deletecustomerbyid.md) - [Update a customer](https://developer.pexipengage.com/operation/operation-updatecustomerbyid.md) ### [Data export](https://developer.pexipengage.com/group/endpoint-data-export.md) - [Retrieve appointments data in csv-format](https://developer.pexipengage.com/operation/operation-dataexportappointments.md) - [Retrieve conversion analytics sessions data in csv-format](https://developer.pexipengage.com/operation/operation-dataexportconversionanalyticssessions.md) ### [Defined availability](https://developer.pexipengage.com/group/endpoint-defined-availability.md) - [Get defined availability](https://developer.pexipengage.com/operation/operation-getdefinedavailability.md) ### [Employees](https://developer.pexipengage.com/group/endpoint-employees.md) - [Get applied templates](https://developer.pexipengage.com/operation/operation-getappliedtemplates.md) - [Apply an availability template](https://developer.pexipengage.com/operation/operation-applyavailabilitytemplate.md) - [Revert applied templates](https://developer.pexipengage.com/operation/operation-revertappliedtemplates.md) - [Get availability templates](https://developer.pexipengage.com/operation/operation-getavailabilitytemplates.md) - [Create an availability template](https://developer.pexipengage.com/operation/operation-createavailabilitytemplate.md) - [Get an availability template](https://developer.pexipengage.com/operation/operation-getavailabilitytemplatebyid.md) - [Delete an availability template](https://developer.pexipengage.com/operation/operation-deleteavailabilitytemplatebyid.md) - [Update an availability template](https://developer.pexipengage.com/operation/operation-updateavailabilitytemplatebyid.md) - [Get availability time ranges](https://developer.pexipengage.com/operation/operation-getavailabilitytimeranges.md) - [Create an availability time range](https://developer.pexipengage.com/operation/operation-createavailabilitytimerange.md) - [Get an availability time range](https://developer.pexipengage.com/operation/operation-getavailabilitytimerangebyid.md) - [Delete an availability time range](https://developer.pexipengage.com/operation/operation-deleteavailabilitytimerangebyid.md) - [Update an availability time range](https://developer.pexipengage.com/operation/operation-updateavailabilitytimerangebyid.md) - [Get time range availability settings](https://developer.pexipengage.com/operation/operation-gettimerangeavailabilitysettings.md) - [Update time range availability settings](https://developer.pexipengage.com/operation/operation-updatetimerangeavailabilitysettings.md) - [Get employees](https://developer.pexipengage.com/operation/operation-getemployees.md) - [Create an employee](https://developer.pexipengage.com/operation/operation-createemployee.md) - [Get an employee](https://developer.pexipengage.com/operation/operation-getemployeebyid.md) - [Delete an employee](https://developer.pexipengage.com/operation/operation-deleteemployeebyid.md) - [Update an employee](https://developer.pexipengage.com/operation/operation-updateemployeebyid.md) - [Reset an employee](https://developer.pexipengage.com/operation/operation-resetemployeebyid.md) - [Get authorized profile picture upload URL](https://developer.pexipengage.com/operation/operation-getauthorizedprofilepictureurl.md) - [Get employee unavailability](https://developer.pexipengage.com/operation/operation-getemployeeunavailability.md) - [Create unavailability](https://developer.pexipengage.com/operation/operation-createunavailability.md) - [Create unavailability event](https://developer.pexipengage.com/operation/operation-createunavailabilityevent.md) - [Delete unavailability](https://developer.pexipengage.com/operation/operation-deleteunavailability.md) - [Revert unavailability](https://developer.pexipengage.com/operation/operation-revertunavailability.md) - [Put expertise for employee](https://developer.pexipengage.com/operation/operation-putexpertiseforemployee.md) - [Get external calendar events](https://developer.pexipengage.com/operation/operation-getexternalcalendarevents.md) - [Get favorite agents](https://developer.pexipengage.com/operation/operation-getfavoriteagents.md) - [Update favorite agents](https://developer.pexipengage.com/operation/operation-updatefavoriteagents.md) - [Get office coverage regions](https://developer.pexipengage.com/operation/operation-getofficecoverageregions.md) - [Update office coverage regions](https://developer.pexipengage.com/operation/operation-updateofficecoverageregions.md) - [Get office subject coverage regions](https://developer.pexipengage.com/operation/operation-getofficesubjectcoverageregions.md) - [Update office subject coverage regions](https://developer.pexipengage.com/operation/operation-updateofficesubjectcoverageregions.md) ### [Fetch configurations](https://developer.pexipengage.com/group/endpoint-fetch-configurations.md) - [Get fetch configurations](https://developer.pexipengage.com/operation/operation-getfetchconfigurations.md) - [Create a fetch configuration](https://developer.pexipengage.com/operation/operation-createfetchconfiguration.md) - [Get a fetch configuration](https://developer.pexipengage.com/operation/operation-getfetchconfigurationbyid.md) - [Delete a fetch configuration](https://developer.pexipengage.com/operation/operation-deletefetchconfigurationbyid.md) - [Update a fetch configuration](https://developer.pexipengage.com/operation/operation-updatefetchconfigurationbyid.md) ### [Files](https://developer.pexipengage.com/group/endpoint-files.md) - [Get files](https://developer.pexipengage.com/operation/operation-getfiles.md) - [Get a file](https://developer.pexipengage.com/operation/operation-getfilebyid.md) - [Download the file](https://developer.pexipengage.com/operation/operation-downloadfile.md) - [Upload the file](https://developer.pexipengage.com/operation/operation-uploadfile.md) ### [Forms](https://developer.pexipengage.com/group/endpoint-forms.md) - [Get forms](https://developer.pexipengage.com/operation/operation-getforms.md) - [Create a form](https://developer.pexipengage.com/operation/operation-createform.md) - [Get a form](https://developer.pexipengage.com/operation/operation-getformbyid.md) - [Delete a form](https://developer.pexipengage.com/operation/operation-deleteformbyid.md) - [Update a form](https://developer.pexipengage.com/operation/operation-updateformbyid.md) - [Get form questions](https://developer.pexipengage.com/operation/operation-getformquestions.md) - [Create a form question](https://developer.pexipengage.com/operation/operation-createformquestion.md) - [Get a form question](https://developer.pexipengage.com/operation/operation-getformquestionbyid.md) - [Delete a form question](https://developer.pexipengage.com/operation/operation-deleteformquestionbyid.md) - [Update a form question](https://developer.pexipengage.com/operation/operation-updateformquestionbyid.md) ### [Lead segments](https://developer.pexipengage.com/group/endpoint-lead-segments.md) - [Get lead segments](https://developer.pexipengage.com/operation/operation-getleadsegments.md) - [Create a lead segment](https://developer.pexipengage.com/operation/operation-createleadsegment.md) - [Get a lead segment](https://developer.pexipengage.com/operation/operation-getleadsegmentbyid.md) - [Delete a lead segment](https://developer.pexipengage.com/operation/operation-deleteleadsegmentbyid.md) - [Update a lead segment](https://developer.pexipengage.com/operation/operation-updateleadsegmentbyid.md) - [Get lead segment scheduling settings](https://developer.pexipengage.com/operation/operation-getleadsegmentschedulingsettings.md) - [Update lead segment scheduling settings](https://developer.pexipengage.com/operation/operation-updateleadsegmentschedulingsettings.md) ### [Listings](https://developer.pexipengage.com/group/endpoint-listings.md) - [Get listings](https://developer.pexipengage.com/operation/operation-getlistings.md) - [Create a listing](https://developer.pexipengage.com/operation/operation-createlisting.md) - [Get a listing](https://developer.pexipengage.com/operation/operation-getlistingbyid.md) - [Delete a listing](https://developer.pexipengage.com/operation/operation-deletelistingbyid.md) - [Update a listing](https://developer.pexipengage.com/operation/operation-updatelistingbyid.md) - [Get listing scheduling settings](https://developer.pexipengage.com/operation/operation-getlistingschedulingsettings.md) - [Update listing scheduling settings](https://developer.pexipengage.com/operation/operation-updatelistingschedulingsettings.md) - [Get listing time slots](https://developer.pexipengage.com/operation/operation-getlistingtimeslots.md) - [Create a listing time slot](https://developer.pexipengage.com/operation/operation-createlistingtimeslot.md) - [Get a listing time slot](https://developer.pexipengage.com/operation/operation-getlistingtimeslotbyid.md) - [Update a listing time slot](https://developer.pexipengage.com/operation/operation-updatelistingtimeslotbyid.md) - [Delete a listing time slot](https://developer.pexipengage.com/operation/operation-deletelistingtimeslotbyid.md) ### [Meeting rooms](https://developer.pexipengage.com/group/endpoint-meeting-rooms.md) - [Get Meeting Rooms](https://developer.pexipengage.com/operation/operation-getmeetingrooms.md) - [Get a meeting room](https://developer.pexipengage.com/operation/operation-getmeetingroombyid.md) ### [Offices](https://developer.pexipengage.com/group/endpoint-offices.md) - [Get offices](https://developer.pexipengage.com/operation/operation-getoffices.md) - [Create an office](https://developer.pexipengage.com/operation/operation-createoffice.md) - [Get an office](https://developer.pexipengage.com/operation/operation-getofficebyid.md) - [Delete an office](https://developer.pexipengage.com/operation/operation-deleteofficebyid.md) - [Update an office](https://developer.pexipengage.com/operation/operation-updateofficebyid.md) - [Link a meeting room to an office](https://developer.pexipengage.com/operation/operation-linkmeetingroomtooffice.md) - [Unlink a meeting room from an office](https://developer.pexipengage.com/operation/operation-unlinkmeetingroomfromoffice.md) - [Get office scheduling settings](https://developer.pexipengage.com/operation/operation-getofficeschedulingsettings.md) - [Update office scheduling settings](https://developer.pexipengage.com/operation/operation-updateofficeschedulingsettings.md) - [Get expertises](https://developer.pexipengage.com/operation/operation-getexpertises.md) - [Update expertises](https://developer.pexipengage.com/operation/operation-updateexpertises.md) - [Get office subject availability settings](https://developer.pexipengage.com/operation/operation-getofficesubjectavailabilitysettings.md) - [Update office subject availability settings](https://developer.pexipengage.com/operation/operation-updateofficesubjectavailabilitysettings.md) - [Get subject office scheduling settings](https://developer.pexipengage.com/operation/operation-getsubjectofficeschedulingsettings.md) - [Update subject office scheduling settings](https://developer.pexipengage.com/operation/operation-updatesubjectofficeschedulingsettings.md) ### [Plugin](https://developer.pexipengage.com/group/endpoint-plugin.md) - [Go to plugin edit action](https://developer.pexipengage.com/operation/operation-getpluginediturl.md) ### [Regions](https://developer.pexipengage.com/group/endpoint-regions.md) - [Get Regions](https://developer.pexipengage.com/operation/operation-getregions.md) ### [Schedulable](https://developer.pexipengage.com/group/endpoint-schedulable.md) - [Get schedulable employees](https://developer.pexipengage.com/operation/operation-getschedulableemployees.md) - [Get schedulable meeting types](https://developer.pexipengage.com/operation/operation-getschedulablemeetingtypes.md) - [Get schedulable offices](https://developer.pexipengage.com/operation/operation-getschedulableoffices.md) - [Get schedulable subjects](https://developer.pexipengage.com/operation/operation-getschedulablesubjects.md) ### [Settings](https://developer.pexipengage.com/group/endpoint-settings.md) - [Get enterprise settings](https://developer.pexipengage.com/operation/operation-getenterprisesettings.md) - [Update enterprise settings](https://developer.pexipengage.com/operation/operation-updateenterprisesettings.md) ### [Subject groups](https://developer.pexipengage.com/group/endpoint-subject-groups.md) - [Get subject groups](https://developer.pexipengage.com/operation/operation-getsubjectgroups.md) - [Create a subject group](https://developer.pexipengage.com/operation/operation-createsubjectgroup.md) - [Get a subject group](https://developer.pexipengage.com/operation/operation-getsubjectgroup.md) - [Delete a subject group](https://developer.pexipengage.com/operation/operation-deletesubjectgroupbyid.md) - [Update a subject group](https://developer.pexipengage.com/operation/operation-updatesubjectgroupbyid.md) ### [Subjects](https://developer.pexipengage.com/group/endpoint-subjects.md) - [Get subjects](https://developer.pexipengage.com/operation/operation-getsubjects.md) - [Create a subject](https://developer.pexipengage.com/operation/operation-createsubject.md) - [Get a subject](https://developer.pexipengage.com/operation/operation-getsubjectbyid.md) - [Delete a subject](https://developer.pexipengage.com/operation/operation-deletesubjectbyid.md) - [Update a subject](https://developer.pexipengage.com/operation/operation-updatesubjectbyid.md) - [Get subject availability settings](https://developer.pexipengage.com/operation/operation-getsubjectavailabilitysettings.md) - [Update subject availability settings](https://developer.pexipengage.com/operation/operation-updatesubjectavailabilitysettings.md) - [Get subject scheduling settings](https://developer.pexipengage.com/operation/operation-getsubjectschedulingsettings.md) - [Update subject scheduling settings](https://developer.pexipengage.com/operation/operation-updatesubjectschedulingsettings.md) ### [Timetable](https://developer.pexipengage.com/group/endpoint-timetable.md) - [Get timetable](https://developer.pexipengage.com/operation/operation-gettimetable.md) ### [Unavailability](https://developer.pexipengage.com/group/endpoint-unavailability.md) - [Get unavailability](https://developer.pexipengage.com/operation/operation-getunavailability.md) ### [Video](https://developer.pexipengage.com/group/endpoint-video.md) - [Go to the video meeting](https://developer.pexipengage.com/operation/operation-getvideourl.md) - [Go to the video test meeting](https://developer.pexipengage.com/operation/operation-getvideotesturl.md) ## Webhooks ### [Appointment create](https://developer.pexipengage.com/group/webhook-appointment-create.md) - [appointment.create](https://developer.pexipengage.com/operation/operation-post-AppointmentCreate.md) ### [Appointment update](https://developer.pexipengage.com/group/webhook-appointment-update.md) - [appointment.update](https://developer.pexipengage.com/operation/operation-post-AppointmentUpdate.md) ### [Callback request create](https://developer.pexipengage.com/group/webhook-callback-request-create.md) - [callback-request.create](https://developer.pexipengage.com/operation/operation-post-CallbackRequestCreate.md) ### [Callback request update](https://developer.pexipengage.com/group/webhook-callback-request-update.md) - [appointment.update](https://developer.pexipengage.com/operation/operation-post-CallbackRequestUpdate.md) ### [Communication webhook](https://developer.pexipengage.com/group/webhook-communication-webhook.md) - [communication.send](https://developer.pexipengage.com/operation/operation-post-CommunicationWebhook.md) ### [Ping webhook](https://developer.pexipengage.com/group/webhook-ping-webhook.md) - [ping](https://developer.pexipengage.com/operation/operation-post-PingWebhook.md) [Powered by Bump.sh](https://bump.sh)