Pexip Engage API documentation

Toggle dark mode

API Changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Find out more about Pexip Engage

production

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
Customers
Defined availability
- Get defined availability
  GET
Employees
Fetch configurations
Forms
Lead segments
Listings
Offices
Plugin
- Go to plugin edit action
  GET
Regions
- Get regions
  GET
Schedulable
Settings
- Get enterprise settings
  GET
- Update enterprise settings
  PATCH
Static translation overrides
- Get static translation overrides
  GET
- Override static translations
  PATCH
Static translations
- Get static translations for language
  GET
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
- POST Appointment
  POST
Ping
- POST Ping
  POST

Powered by Bump.sh

Countries

When indicating a specific country, a country code that is compliant with ISO-3166-1 alpha-2 country codes should be used.