API changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Find out more about Pexip Engage

Toggle dark mode

development

production default
development
staging

Topics

Introduction
Authentication
Registering an application
Requests and responses
Languages & translations
Countries
Dates & time
Collection resource properties
Pagination
Eventual consistency
Rate limiting
File uploading
Error codes
Provisioning
Webhooks
API upgrades
Migrating from the legacy API

Endpoints

Appointments
Calendar event
Callback requests
Contexts
- Get a context GET
- Create a context POST
Customers
Data export
- Retrieve data in csv-format GET
Defined availability
- Get defined availability GET
Employees
Fetch configurations
Files
Forms
Lead segments
Listings
Meeting rooms
- Get Meeting Rooms GET
- Get a meeting room GET
Offices
Plugin
- Go to plugin edit action GET
Regions
- Get Regions GET
Schedulable
Settings
- Get enterprise settings GET
- Update enterprise settings PATCH
Subject groups
Subjects
Timetable
- Get timetable GET
Unavailability
- Get unavailability GET
Video
- Go to the video meeting GET
- Go to the video test meeting GET

Webhooks

Appointment create
- Appointment.create POST
Appointment update
- Appointment.update POST
Callback request create
- Callback-request.create POST
Callback request update
- Appointment.update POST
Communication webhook
- Communication.send POST

Powered by Bump.sh

API changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Find out more about Pexip Engage

Toggle dark mode

Registering an application

Contact your account manager to receive a client_id and client_secret with the desired scopes.