Partner API reference

The arztkonsultation Partner API is the public server-to-server contract for integration partners. The current stable version is 1.10.0.

OpenAPI JSON 1.10.0
OpenAPI YAML 1.10.0
Checksums 1.10.0

Immutable downloads for version 1.10.0 are available under /api/versions/1.10.0/; version 1.9.0 and older versions remain available as historical contracts.

Language

curl --request GET \
  --url https://sandbox.arztkonsultation.io/api/v1/s2s/scheduling/appointment-types \
  --header 'Accept: application/json' \
  --header 'X-API-Key: {PARTNER_API_KEY}'

Published endpoints

From the immutable OpenAPI 1.10.0 contract.

OpenAPI JSON

Appointments & bookings

GET
/api/v1/s2s/appointments
List partner appointments
GET
/api/v1/s2s/appointments/{appointmentId}
Get partner appointment
POST
/api/v1/s2s/appointments/{appointmentId}/cancel
Cancel partner appointment
POST
/api/v1/s2s/bookings
Create a booking

Providers & availability

POST
/api/v1/s2s/organizations
Create an organization
POST
/api/v1/s2s/providers
Create a provider
POST
/api/v1/s2s/providers/{providerId}/availability-rules
Create provider availability rule
GET
/api/v1/s2s/providers/{providerId}/slots
List provider slots
POST
/api/v1/s2s/providers/{providerId}/specialties
Attach provider specialty
GET
/api/v1/s2s/scheduling/appointment-types
List partner appointment types
GET
/api/v1/s2s/scheduling/appointment-types/{appointmentTypeId}/email-message-settings
Get appointment-type email message settings
PATCH
/api/v1/s2s/scheduling/appointment-types/{appointmentTypeId}/email-message-settings
Update appointment-type email message settings
GET
/api/v1/s2s/scheduling/appointment-types/{appointmentTypeId}/email-reminder
Get appointment-type email reminder configuration
PATCH
/api/v1/s2s/scheduling/appointment-types/{appointmentTypeId}/email-reminder
Update appointment-type email reminder configuration
PATCH
/api/v1/s2s/scheduling/appointment-types/{appointmentTypeId}/intake-fields
Replace appointment-type intake fields
GET
/api/v1/s2s/scheduling/appointment-types/{appointmentTypeId}/scheduling-policy
Get an appointment-type scheduling policy
PATCH
/api/v1/s2s/scheduling/appointment-types/{appointmentTypeId}/scheduling-policy
Update an appointment-type scheduling policy
GET
/api/v1/s2s/scheduling/appointment-types/{appointmentTypeId}/sms-confirmation
Get appointment-type SMS confirmation configuration
PATCH
/api/v1/s2s/scheduling/appointment-types/{appointmentTypeId}/sms-confirmation
Update appointment-type SMS confirmation configuration
GET
/api/v1/s2s/scheduling/organizations/{organizationId}/email-message-settings
Get organization email message settings
PATCH
/api/v1/s2s/scheduling/organizations/{organizationId}/email-message-settings
Update organization email message settings
GET
/api/v1/s2s/scheduling/organizations/{organizationId}/email-reminder
Get organization email reminder configuration
PATCH
/api/v1/s2s/scheduling/organizations/{organizationId}/email-reminder
Update organization email reminder configuration
GET
/api/v1/s2s/scheduling/organizations/{organizationId}/scheduling-policy
Get an organization scheduling policy
PATCH
/api/v1/s2s/scheduling/organizations/{organizationId}/scheduling-policy
Update an organization scheduling policy
GET
/api/v1/s2s/scheduling/organizations/{organizationId}/sms-confirmation
Get organization SMS confirmation configuration
PATCH
/api/v1/s2s/scheduling/organizations/{organizationId}/sms-confirmation
Update organization SMS confirmation configuration
GET
/api/v1/s2s/scheduling/providers/{providerId}/availability-rules
List partner provider availability rules
POST
/api/v1/s2s/scheduling/providers/{providerId}/availability-rules
Create partner provider availability rule
PATCH
/api/v1/s2s/scheduling/providers/{providerId}/availability-rules/{ruleId}
Update partner provider availability rule
DELETE
/api/v1/s2s/scheduling/providers/{providerId}/availability-rules/{ruleId}
Deactivate partner provider availability rule
GET
/api/v1/s2s/scheduling/providers/{providerId}/slots
List partner provider slots

Partner pharmacies & organizations

GET
/api/v1/s2s/partners/pharmacies
List partner pharmacies
POST
/api/v1/s2s/partners/pharmacies
Register a partner pharmacy
POST
/api/v1/s2s/partners/pharmacies/{consumerId}/claim
Claim a console-created pharmacy
GET
/api/v1/s2s/partners/pharmacies/{partnerOrgId}
Get a partner pharmacy registration
PATCH
/api/v1/s2s/partners/pharmacies/{partnerOrgId}
Update pharmacy master data
GET
/api/v1/s2s/partners/pharmacies/{partnerOrgId}/additional-confirmation-recipients
Get additional confirmation recipients for a partner pharmacy
GET
/api/v1/s2s/partners/pharmacies/{partnerOrgId}/kim-address
Get a partner pharmacy KIM address
PATCH
/api/v1/s2s/partners/pharmacies/{partnerOrgId}/kim-address
Update a partner pharmacy KIM address
POST
/api/v1/s2s/partners/pharmacies/{partnerOrgId}/login-links
Create a one-time backoffice login link
POST
/api/v1/s2s/partners/pharmacies/{partnerOrgId}/offboarding-requests
Request partner pharmacy offboarding
GET
/api/v1/s2s/partners/pharmacies/{partnerOrgId}/resource-mode
Read partner pharmacy resource mode
POST
/api/v1/s2s/partners/pharmacies/{partnerOrgId}/resource-mode
Switch partner pharmacy resource mode
GET
/api/v1/s2s/partners/pharmacies/{partnerOrgId}/smed-config
Get a partner pharmacy SMED identifier
PATCH
/api/v1/s2s/partners/pharmacies/{partnerOrgId}/smed-config
Update a partner pharmacy SMED identifier
POST
/api/v1/s2s/partners/settings-copy/apply
Apply partner pharmacy settings copy
POST
/api/v1/s2s/partners/settings-copy/preview
Preview partner pharmacy settings copy

Webhooks

GET
/api/v1/s2s/partners/pharmacies/{partnerOrgId}/webhooks
List partner pharmacy webhooks
POST
/api/v1/s2s/partners/pharmacies/{partnerOrgId}/webhooks
Create partner pharmacy webhook
DELETE
/api/v1/s2s/partners/pharmacies/{partnerOrgId}/webhooks/{webhookId}
Deactivate partner pharmacy webhook
POST
/api/v1/s2s/partners/pharmacies/{partnerOrgId}/webhooks/{webhookId}/test
Send webhook test delivery
POST
/api/v1/s2s/partners/webhooks
Set the channel-wide webhook

Rooms & resources

GET
/api/v1/s2s/pharmacy/rooms
List partner pharmacy rooms
POST
/api/v1/s2s/pharmacy/rooms
Create partner pharmacy room
PATCH
/api/v1/s2s/pharmacy/rooms/{roomId}
Update partner pharmacy room
DELETE
/api/v1/s2s/pharmacy/rooms/{roomId}
Deactivate partner pharmacy room
POST
/api/v1/s2s/pharmacy/rooms/{roomId}/availability-rules
Create partner pharmacy room availability rule
PATCH
/api/v1/s2s/pharmacy/rooms/{roomId}/availability-rules/{ruleId}
Update partner pharmacy room availability rule
DELETE
/api/v1/s2s/pharmacy/rooms/{roomId}/availability-rules/{ruleId}
Deactivate partner pharmacy room availability rule
GET
/api/v1/s2s/pharmacy/rooms/{roomId}/exceptions
List active room exception groups
POST
/api/v1/s2s/pharmacy/rooms/{roomId}/exceptions
Create or replace a room exception
POST
/api/v1/s2s/pharmacy/rooms/{roomId}/exceptions/{exceptionId}/retract
Retract a room exception
POST
/api/v1/s2s/pharmacy/rooms/{roomId}/holiday-openings/{date}/revoke
Close an opened holiday again
POST
/api/v1/s2s/pharmacy/rooms/{roomId}/schedule-changes
Change the weekly hours of a room from a date
GET
/api/v1/s2s/pharmacy/rooms/calendar
Read the pharmacy room calendar
POST
/api/v1/s2s/pharmacy/rooms/calendar/impact
Preview the impact of a room calendar command
POST
/api/v1/s2s/pharmacy/rooms/closures
Close one, several or all rooms for a range
GET
/api/v1/s2s/pharmacy/rooms/holiday-policy
Read the pharmacy holiday policy