Pexip Engage logo
API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Find out more about Pexip Engage
staging
  • 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
    • Get appointments GET
    • Create an appointment POST
    • Get an appointment GET
    • Update an appointment PATCH
    • Create an appointment invite POST
    • Accept an appointment POST
    • Cancel an appointment POST
    • Complete an appointment POST
    • Reassign an appointment POST
    • Reopen an appointment POST
    • Request an appointment reschedule POST
    • Reschedule an appointment POST
  • Calendar event
    • Add appointment to Google Calendar GET
    • Add appointment to Office365 Calendar GET
    • Download the appointment ICal file GET
  • Customers
    • Get customers GET
    • Create a customer POST
    • Get a customer GET
    • Delete a customer DELETE
    • Update a customer PATCH
  • Defined availability
    • Get defined availability GET
  • Employees
    • Get applied templates GET
    • Apply an availability template POST
    • Revert applied templates DELETE
    • Get availability templates GET
    • Create an availability template POST
    • Get an availability template GET
    • Delete an availability template DELETE
    • Update an availability template PATCH
    • Get availability time ranges GET
    • Create an availability time range POST
    • Get an availability time range GET
    • Delete an availability time range DELETE
    • Update an availability time range PATCH
    • Get time range availability settings GET
    • Update time range availability settings PUT
    • Get employees GET
    • Create an employee POST
    • Get an employee GET
    • Delete an employee DELETE
    • Update an employee PATCH
    • Reset an employee POST
    • Get authorized profile picture upload URL GET
    • Get employee unavailability GET
    • Create unavailability POST
    • Revert unavailability DELETE
    • Get external calendar events GET
    • Get favorite agents GET
    • Update favorite agents PUT
    • Get office coverage regions GET
    • Update office coverage regions PUT
    • Get office subject coverage regions GET
    • Update office subject coverage regions PUT
  • Fetch configurations
    • Get fetch configurations GET
    • Create a fetch configuration POST
    • Get a fetch configuration GET
    • Delete a fetch configuration DELETE
    • Update a fetch configuration PATCH
  • Forms
    • Get forms GET
    • Create a form POST
    • Get a form GET
    • Delete a form DELETE
    • Update a form PATCH
    • Get form questions GET
    • Create a form question POST
    • Get a form question GET
    • Delete a form question DELETE
    • Update a form question PATCH
  • Lead segments
    • Get lead segments GET
    • Create a lead segment POST
    • Get a lead segment GET
    • Delete a lead segment DELETE
    • Update a lead segment PATCH
    • Get lead segment scheduling settings GET
    • Update lead segment scheduling settings PUT
  • Listings
    • Get listings GET
    • Create a listing POST
    • Get a listing GET
    • Delete a listing DELETE
    • Update a listing PATCH
    • Get listing scheduling settings GET
    • Update listing scheduling settings PUT
    • Get listing time slots GET
    • Create a listing time slot POST
    • Get a listing time slot GET
    • Update a listing time slot PUT
    • Delete a listing time slot DELETE
  • Offices
    • Get offices GET
    • Create an office POST
    • Get an office GET
    • Delete an office DELETE
    • Update an office PATCH
    • Get office scheduling settings GET
    • Update office scheduling settings PUT
    • Get expertises GET
    • Update expertises PUT
    • Get office subject availability settings GET
    • Update office subject availability settings PUT
    • Get subject office scheduling settings GET
    • Update subject office scheduling settings PUT
  • Plugin
    • Go to plugin edit action GET
  • Regions
    • Get regions GET
  • Schedulable
    • Get schedulable employees GET
    • Get schedulable meeting types GET
    • Get schedulable offices GET
    • Get schedulable subjects GET
  • 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
    • Get subject groups GET
    • Create a subject group POST
    • Get a subject group GET
    • Delete a subject group DELETE
    • Update a subject group PATCH
  • Subjects
    • Get subjects GET
    • Create a subject POST
    • Get a subject GET
    • Delete a subject DELETE
    • Update a subject PATCH
    • Get subject availability settings GET
    • Update subject availability settings PUT
    • Get subject scheduling settings GET
    • Update subject scheduling settings PUT
  • 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

Forms

Operations
GET /forms POST /forms GET /forms/{id} DELETE /forms/{id} PATCH /forms/{id} GET /forms/{formId}/questions POST /forms/{formId}/questions GET /forms/{formId}/questions/{id} DELETE /forms/{formId}/questions/{id} PATCH /forms/{formId}/questions/{id}