API upgrades

Keep track of changes and upgrades to the Server API.

Your API version controls the API you see (for example, what properties you see in responses, what parameters you’re permitted to send in requests, and so on).

When a breaking change is introduced to the Server API, a new dated version is released and your calls to the API are not affected as long as you don't change the version you want to query (see versioning).

Below a list of all available versions of the Server API (each date corresponds to version), and their associated breaking changes.
If you’re looking for all API additions and updates, check out our Changelog page.


  • Create version 2023-06-26.
  • The appointment_recording API object ("The appointment recording object represents a URL pointing to an audio recording of an appointment.") had the naming of its properties aligned with our general convention: expiresAt -> expires_at.


  • Create version 2023-05-25.
  • For Copilot API calls targeting this version or higher,
    the generated clinical note will have no formatting (e.g. prepending - for bullet point strings).
    You should from now on add your own formatting.


  • Create version 2023-05-12
  • Payload of webhook conversation.message.created now returns the concerned conversation along with the new message.
  • Rename is_patient_task to is_assigned_to_patient in /tasks.


  • Create version 2023-04-26
  • Support blood pressure in FHIR Observation API:
    • New enum value for Observation.type: BLOOD_PRESSURE_SYSTOLIC_DIASTOLIC_MMHG.
    • New field: value_string only applicable for blood pressure (for which it will be <Systolic (in mmHg)>/<Diastolic (in mmHg)>).
    • Deprecate quantitative_value in favor of the new equivalent value_decimal (basically a renaming).


  • Create version 2023-04-13
  • In Webhooks, deprecated appointment.note.updated to be replaced with appointment.updated that covers more use cases.


  • Create version 2023-04-06
  • In Appointment, change the type of note into a simple string and add a title property


  • Create new version 2023-03-28
  • In The Availability object, supported_modes no longer return an array of enum ['NABLA_VIDEOCALL', 'EXTERNAL_VIDEOCALL', 'IN_PERSON'] but an array of enum containing only 2 values: 'VIDEOCALL' or 'IN_PERSON'
  • In Create an availability, the supported_modes property, in body params, can be set with an array of enum containing 2 possible values: 'VIDEOCALL' or 'IN_PERSON'




  • Multiple assigned providers per conversation instead of only one.
  • Update the get conversation endpoint to return an assigned_providers field being a list of provider instead of a single assigned_provider.
  • Update the create conversation endpoint to accept an assigned_provider_ids field instead of a single assigned_provider_id.
  • Update the update conversation endpoint to accept an assigned_provider_ids field instead of a single assigned_provider_id.
  • Add EXTERNAL_VIDEOCALL mode to the Appointment object.
  • Add external_videocall_url to the Appointment object.


  • Appointment url is now a child of the Appointment object
    instead of being a sibling in the response body of the Create Appointment endpoint.
  • Phone numbers format in patient and provider objects are updated and prefixed, from this version, with the '+' sign and still following the E.164 ITU recommendation


2 parameters are renamed in this version:

  • Deprecate text and attachment in Message create and replace them with content, a composite type that can be either a text or an attachment (but not both at the same time)
  • In QuestionnaireResponses create and update operations, data parameter is renamed into items.
  • In Patient create and update operations, patient_field_values parameter is renamed into custom_fields.


This version deprecates the support of updates via HTTP PUT requests. From that point, any update needs to be made with an HTTP PATCH request.


With this version, conversations can contain multiple patients and this change introduce the following breaking changes:

  • The conversation object:

    • The patient field is deprecated and replaced by patients, which contains the list of patients included in the conversation
  • Create a conversation, in body params:

    • patient_id is deprecated and replaced by patient_ids, which contains the list of patients included in this conversation.
    • A new field is required, type, to categorize the conversation with 2 possible values:
      • individual_conversation, when there's a single patient with one or several practitioners
      • group_conversation for conversation with several patients.


First version of the API