How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Docplanner Integrations API

OAuth 2.0 REST API (v1.14.0) for medical-software vendors integrating a practice-management system with the ZnanyLekarz marketplace. 44 operations across facilities, doctors, addresses, services, insurance providers, calendars, calendar breaks, slots, bookings and patient presence, plus 17 push/pull event notification callbacks. The Polish locale resolves the templated server host to www.znanylekarz.pl, as stated in the specification's own locale table.

Docplanner Integrations API is published by ZnanyLekarz on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Booking, Scheduling, Healthcare, and Appointments. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 44 operations across 32 paths, organized into 11 resource areas, and defines 82 schemas. It is described by OpenAPI 3.0.3, at version 1.14.0.

Requests are made against a single base URL, https://www.{domain}/api/v3/integration.

44 operations 32 paths 82 schemas 7 DELETE20 GET3 PATCH10 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.14.0
Base URL
https://www.znanylekarz.pl/api/v3/integration
Authentication
OAuth 2.0
Resource Areas
11

Authentication & Security 1

Docplanner Integrations API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

  • oauth2 — The API utilizes the industry-standard [OAuth 2.0](https://tools.ietf.org/html/rfc6749) protocol. All requests to our API must be authenticated and must includ…

Paths & Operations 44

Across 32 paths, the API surfaces 44 operations — 7 DELETE, 20 GET, 3 PATCH, 10 POST, 4 PUT. They span 11 resource areas, including Facilities, Doctors, Addresses, Services, Insurances, Calendars, Calendar Breaks, Slots, and 3 more. Each is listed below with its method, path, parameters, and response codes.

Facilities 2

More information on how we define what a Facility is, its use cases and more can be found [here](https://integrations.docplanner.com/guide/api-objects/resources.htmlfacilities).

GET
/facilities
Get a list of facilities
getFacilities → 200
GET
/facilities/{facility_id}
Get a single facility Extensions: facility.doctors - with this parameter in url, query results will return a list of all the doctors in a given facility
getFacility 2 params → 200403404
Doctors 2

More information on how we define what a Doctors is, its use cases and more can be found [here](https://integrations.docplanner.com/guide/api-objects/resources.htmldoctors).

GET
/facilities/{facility_id}/doctors
Get a list of doctors in a facility Extensions: doctor.profileurl - with this parameter in url, query results will contain urls to doctors profiles doctor.specializations - with this parameter in url…
getDoctors 2 params → 200403404
GET
/facilities/{facility_id}/doctors/{doctor_id}
Get a single doctor in a facility Extensions: doctor.profileurl - with this parameter in url, query results will contain urls to doctors profiles doctor.addresses - with this parameter in url, query…
getDoctor 3 params → 200403404
Addresses 4

More information on how we define what a Addresses is, its use cases and more can be found [here](https://integrations.docplanner.com/guide/api-objects/resources.htmladdresses).

GET
/facilities/{facility_id}/doctors/{doctor_id}/addresses
Get a list of addresses of a doctor Extensions: address.onlineonly - with this parameter in url, query results will return additional parameter indicating if returned addresses are dedicated to video…
getAddresses 3 params → 200403404
GET
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}
Get a single address of a doctor Extensions: address.onlineonly - with this parameter in url, query results will return additional parameter indicating if an address is dedicated to video consultatio…
getAddress 4 params → 200403404
PATCH
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}
Get a single address of a doctor
updateAddress 3 params body → 200400403404
DELETE
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/integration
Remove the integration mark from a single address. After this call, Docplanner will no longer treat the address as integrated with the API client's system. The address itself is not deleted. Endpoint…
removeAddressIntegration 3 params → 202403404
Services 6

More information on how we define what a Services is, its use cases and more can be found [here](https://integrations.docplanner.com/guide/api-objects/resources.htmlservices).

GET
/services
Services returned in this endpoint are dictionary services. Services returned here are from a dictionary (itemservices). Extensions: services.onlydiagnostics - with this parameter in url, query resul…
getServices 2 params → 200
GET
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services
Services returned in this endpoint are address services. Services returned here are from specified address (addressservices). Extensions: addressservice.allowedpatients - with this parameter in url,…
getAddressServices 5 params → 200403404
POST
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services
Adds new service to an address of the doctor Services added here are specific to this address (addressservices).
addAddressService 3 params body → 201400403404409
GET
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id}
Service returned in this endpoint is an address service. Service returned here is from a specified address (addressservices). Extensions: addressservice.allowedpatients - with this parameter in url,…
getAddressService 5 params → 200403404
PATCH
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id}
Service updated in this endpoint is an address service from this specified address (addressservices).
updateAddressService 4 params body → 200400403404
DELETE
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id}
Service deleted in this endpoint is an address service from this specified address (addressservices).
deleteAddressService 4 params → 204403404
Insurances 6

More information on how we define what a Insurances is, its use cases and more can be found [here](https://integrations.docplanner.com/guide/api-objects/resources.htmlinsurances).

GET
/insurance-providers
Get a list of available insurance providers
getInsuranceProviders → 200
GET
/insurance-providers/{insurance_provider_id}/plans
Get a list of available insurance plans for a given insurance provider
getInsurancePlans 1 param → 200
GET
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers
Get a list of insurance providers for a specific address
getAddressInsuranceProviders 3 params → 200403404
POST
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers
Adds new insurance provider to an address of the doctor
addAddressInsuranceProvider 3 params body → 204400403404
PUT
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers
Updates or creates insurance provider for a given doctor address
updateOrCreateAddressInsuranceProvider 3 params body → 204403404
DELETE
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers/{insurance_provider_id}
Delete an insurance provider from doctor’s address
deleteAddressInsuranceProvider 4 params → 204400403404
Calendars 3

Simple operations on the calendar belonging to the address

GET
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/calendar
Gets calendar of the address
getCalendar 3 params → 200403404
POST
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/calendar/enable
Enable calendar on the address
enableCalendar 3 params → 200400403409422
POST
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/calendar/disable
Disable calendar on the address
disableCalendar 3 params → 200403409
Calendar Breaks 5

More information on how we define what a Calendar Breaks is, its use cases and more can be found [here](https://integrations.docplanner.com/guide/api-objects/resources.htmlcalenda…

GET
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/breaks
Get the list of calendar breaks
getCalendarBreaks 5 params → 200403404
POST
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/breaks
Add a new break to the calendar
addCalendarBreak 3 params body → 201400403404409422
GET
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/breaks/{break_id}
View a specific calendar break
getCalendarBreak 4 params → 200403404
PATCH
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/breaks/{break_id}
Move the calendar break If the break was created with applyoncoupledaddresses, the breaks created alongside it on the doctor's coupled addresses in this facility are moved to the same new time range.
moveCalendarBreak 4 params body → 204400403404422
DELETE
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/breaks/{break_id}
Delete the calendar break If the break was created with applyoncoupledaddresses, the breaks created alongside it on the doctor's coupled addresses in this facility are removed as well.
deleteCalendarBreak 4 params → 204403404
Slots 4

More information on how we define what a Slots is, its use cases and more can be found [here](https://integrations.docplanner.com/guide/api-objects/resources.htmlslots).

GET
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/slots
List of free slots for the address within specified date range. The date range between start and end must not exceed 180 days; requests exceeding this limit will return a 400 error. Extensions: slot.…
getSlots 6 params → 200400403404
PUT
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/slots
Overrides all existing slots for given date ranges. Can be used for adding, replacing or even removing the slots (check description for addressservices in a request body). If a duplicate request (wit…
replaceSlots 3 params body → 201400403404422429
POST
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/slots/{start}/book
Book a slot
bookSlot 4 params body → 200400403404422
DELETE
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/slots/{date}
Delete slots for the given date
deleteSlots 4 params → 204403404
Bookings 6

More information on how we define what a Bookings is, its use cases and more can be found [here](https://integrations.docplanner.com/guide/api-objects/resources.htmlbookings). add…

GET
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings
Get bookings list of a doctor in the facility Passing the page parameter in the query string will enable pagination. Extensions: booking.patient - with this parameter in url, query results will retur…
getBookings 8 params → 200403404
GET
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}
View specific booking. Extensions: booking.moving - with this parameter in url, query results will return moving data (origin and newest booking ids) as long as the booking was created after 2nd Apri…
getBooking 5 params → 200403404
DELETE
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}
Cancel the booking
cancelBooking 4 params body → 204400403404
POST
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/move
Move a booking for a doctor The optional addressid in the body may name an address of a different doctor within the same facility, which reassigns the booking to that doctor. The doctor is taken from…
moveBooking 5 params body → 201400403404409422
PUT
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/confirm
Confirm the booking
confirmBooking 4 params body → 204400403404409
PUT
/facilities/{facility_id}/doctors/{doctor_id}/opinion-request
After the visit was booked via clinics software, by calling this endpoint you can request SMS asking patient to leave an opinion. We do not store patient and visit information
requestOpinion 2 params body → 200400403404409422
Patient Presence 2

More information on how we define what a Patient Presence is, its use cases and more can be found [here](https://integrations.docplanner.com/guide/api-objects/patient-presence.htm…

POST
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/presence/patient
Mark the presence of the patient on the visit
markPatientPresence 4 params → 204400403404409
DELETE
/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/presence/patient
Mark the absence of the patient on the visit
markPatientAbsence 4 params → 204400403404409
API Notification Callbacks 4

More information on how we define what a API Notification Callbacks is, its use cases and more can be found [here](https://integrations.docplanner.com/guide/callbacks/push-vs-pull…

POST
/{client-endpoint-url}
Pushing Notifications - To be able to use this method, client should give us an endpoint url, and we will be pushing notifications to this endpoint in real time. HTTP POST method will be used to push…
Push Notifications → 200
GET
/notifications
Pulling Notifications - You can pull notifications via this endpoint. This page will respond to you with the earliest notification you haven’t been pulled yet. First In First Out (FIFO) principle app…
Pull Notification → 200404
GET
/notifications/multiple
Pulling Notifications - You can pull multiple notifications via this endpoint. This page will respond to you with the earliest notifications you haven’t been pulled yet in the quantity limited by lim…
Pull Multiple Notification 1 param → 200404
POST
/notifications/release
Action allowing to trigger re-dispatching all the notifications that were not processed correctly. Call to this endpoint should be repeated periodically to ensure consistency between systems. Docplan…
Release Notifications → 204403429

Schemas 82

The contract defines 82 schemas that model the data the API accepts and returns. The most detailed are Booking (18 properties), BookingNotification (16 properties), AddressService (11 properties), Address (10 properties). Each schema is shown below with its type and property counts.

Facility
object
3 properties
FacilityScopes
string
Facilities
object
1 property
Doctor
object
6 properties
DoctorsScopes
string
Doctors
object
1 property
DoctorScopes
string
Specialization
object
2 properties
Specializations
object
1 property
LicenseNumber
object
2 properties
LicenseNumbers
object
1 property
Address
object
10 properties
AddressScopes
string
Addresses
object
1 property
AddressesScopes
string
UpdateAddressRequest
object
1 property
Service
object
2 properties
Services
object
1 property
ServicesScopes
string
AllowedPatientsData
object
2 properties
AddressService
object
11 properties
AddressServiceScopes
string
AddressServices
object
1 property
AddressServicesScopes
string
AddAddressServiceRequest
object
8 properties 1 required
UpdateAddressServiceRequest
object
7 properties
InsuranceProvider
object
2 properties
InsuranceProviders
object
1 property
AddressInsuranceProvider
object
3 properties
AddressInsuranceProviders
object
1 property
InsurancePlan
object
2 properties
InsurancePlans
object
1 property
AddAddressInsuranceProviderRequest
object
2 properties 1 required
UpdateOrCreateAddressInsuranceProviderRequest
object
2 properties 1 required
Calendar
object
1 property
CalendarBreak
object
4 properties
CalendarBreaks
object
1 property
AddCalendarBreakRequest
object
4 properties 2 required
MoveCalendarBreakRequest
object
2 properties 2 required
Slot
object
2 properties
Slots
object
1 property
SlotsScopes
string
BookSlotRequest
object
9 properties 3 required
ReplaceSlotsRequest
object
1 property 1 required
Booking
object
18 properties
Bookings
object
5 properties
BookingsScopes
string
BookingScopes
string
MoveBookingScopes
string
Insurance
object
4 properties
BookingPatient
object
9 properties
BookingMoving
object
2 properties
CancelBookingRequest
object
1 property
ConfirmBookingRequest
object
1 property 1 required
MoveBookingRequest
object
4 properties 1 required
Patient
object
9 properties 2 required
OpinionRequest
object
1 property 1 required
AddressServiceNotification
object
5 properties
VisitBookingRequestNotification
object
10 properties
SlotBookingNotification
object
3 properties
InsuranceNotification
object
4 properties
BookingNotification
object
16 properties
SlotBookedNotification
object
3 properties
BookingCanceledNotification
object
3 properties
BookingMovedNotification
object
3 properties
BookingMovingNotification
object
3 properties
BookingConfirmedNotification
object
3 properties
BookingPaymentStatusChangedNotification
object
3 properties
BreakNotification
object
3 properties
BreakCreatedNotification
object
3 properties
BreakRemovedNotification
object
3 properties
BreakMovedNotification
object
3 properties
PresenceMarkedNotification
object
3 properties
AddressServiceCreatedNotification
object
3 properties
AddressServiceDeletedNotification
object
3 properties
AddressServiceChangedNotification
object
3 properties
AddressCommercialTypeChangedNotification
object
3 properties
AddressAssignedNotification
object
3 properties
AddressUnassignedNotification
object
3 properties
Notification
object
3 properties
PullMultipleNotificationsResponse
object
2 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

znanylekarz-integrations-api.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Docplanner Integrations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.