The Calendesk API is a comprehensive suite of HTTP endpoints designed to seamlessly integrate your app with Calendesk's scheduling features.
\nTo access the Calendesk API, a PRO Plan subscription on Calendesk is necessary. Upon subscription, you will be granted an API key.
\nTo authenticate with the Calendesk API, you'll need your Tenant's name - a unique identifier assigned to your account upon registration, and your API Key.
\nTo generate your API key and locate your Tenant Name, navigate to the Integrations / API section in your Calendesk Admin Panel. Here, you'll find everything you need to kickstart your integration with Calendesk's scheduling capabilities.
\nIf you have any questions regarding the API, don't hesitate to contact us at support@calendesk.com. We're here to help!
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"148493","collectionId":"8822fde9-7c47-4d0a-8ba9-5163fdae4154","publishedId":"UV5c9FSc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3b5cc0"},"publishDate":"2024-08-02T11:20:40.000Z"},"item":[{"name":"Admin API","item":[{"name":"Availability Schedule","item":[{"name":"Get All Availability Schedule","id":"0407bd94-20ec-40a2-a0b3-44bd62e501fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-API-Key","type":"text","value":"{{apiKey}}"}],"url":"https://api.calendesk.com/api/admin/availability-schedules?service_ids={{serviceID}}&employee_ids={{employeeID}}&query=Adam","urlObject":{"path":["api","admin","availability-schedules"],"host":["https://api.calendesk.com"],"query":[{"key":"service_ids","value":"{{serviceID}}"},{"key":"employee_ids","value":"{{employeeID}}"},{"key":"query","value":"Adam"}],"variable":[]}},"response":[],"_postman_id":"0407bd94-20ec-40a2-a0b3-44bd62e501fa"},{"name":"Get Availability Schedule","id":"cbe548d5-5c12-40ad-8fc4-581a5bce4842","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Api-Key","type":"text","value":"{{apiKey}}"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"}],"url":"https://api.calendesk.com/api/admin/availability-schedules/2","urlObject":{"path":["api","admin","availability-schedules","2"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cbe548d5-5c12-40ad-8fc4-581a5bce4842"},{"name":"Create Availability Schedule","id":"250a9950-2b58-40ab-a54e-f30caee7ecd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-API-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test schedule Asia/Kuwait\",\n \"time_zone\": \"Asia/Kuwait\",\n \"rules\": [\n {\n \"type\": \"wday\",\n \"wday\": \"monday\",\n \"intervals\": [\n {\n \"start_time\": \"01:00\",\n \"end_time\": \"00:00\"\n }\n ],\n \"service_ids\": [\n 1\n ],\n \"location_ids\": [\n 3\n ]\n },\n {\n \"type\": \"date\",\n \"intervals\": [\n {\n \"start_time\": \"07:00\",\n \"end_time\": \"10:00\"\n },\n {\n \"start_time\": \"11:00\",\n \"end_time\": \"15:00\"\n }\n ],\n \"date\": \"2024-02-15\"\n },\n {\n \"type\": \"date\",\n \"intervals\": [\n {\n \"start_time\": \"07:00\",\n \"end_time\": \"10:00\"\n },\n {\n \"start_time\": \"11:00\",\n \"end_time\": \"15:00\"\n }\n ],\n \"date\": \"2024-02-16\"\n },\n {\n \"type\": \"date\",\n \"intervals\": [\n {\n \"start_time\": \"07:00\",\n \"end_time\": \"10:00\"\n },\n {\n \"start_time\": \"11:00\",\n \"end_time\": \"15:00\"\n }\n ],\n \"date\": \"2024-02-17\"\n },\n {\n \"type\": \"date\",\n \"intervals\": [\n {\n \"start_time\": \"07:00\",\n \"end_time\": \"23:55\"\n }\n ],\n \"date\": \"2024-02-29\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/availability-schedules","urlObject":{"path":["api","admin","availability-schedules"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"250a9950-2b58-40ab-a54e-f30caee7ecd2"},{"name":"Update Availability Schedule","id":"1fb4034d-99ab-4e3e-b6e7-e0ebc041b592","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-API-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test schedule 3\",\n \"time_zone\": \"UTC\",\n \"rules\": [\n {\n \"date\": \"2024-01-22\",\n \"type\": \"date\",\n \"intervals\": [\n {\n \"start_time\": \"01:00\",\n \"end_time\": \"03:00\"\n },\n {\n \"start_time\": \"23:00\",\n \"end_time\": \"23:59\"\n }\n ],\n \"service_ids\": [\n 99\n ],\n \"location_ids\": [\n 3\n ]\n },\n {\n \"date\": \"2024-01-24\",\n \"type\": \"date\",\n \"intervals\": [\n {\n \"start_time\": \"01:00\",\n \"end_time\": \"03:00\"\n }\n ]\n },\n {\n \"date\": \"2024-01-25\",\n \"type\": \"date\",\n \"intervals\": [\n {\n \"start_time\": \"01:00\",\n \"end_time\": \"03:00\"\n }\n ],\n \"service_ids\": [\n 99\n ],\n \"location_ids\": [\n 3\n ]\n },\n {\n \"type\": \"wday\",\n \"wday\": \"monday\",\n \"intervals\": [\n {\n \"start_time\": \"01:00\",\n \"end_time\": \"03:00\"\n },\n {\n \"start_time\": \"00:00\",\n \"end_time\": \"01:00\"\n }\n ],\n \"location_ids\": [\n 1\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/availability-schedules/4","urlObject":{"path":["api","admin","availability-schedules","4"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1fb4034d-99ab-4e3e-b6e7-e0ebc041b592"},{"name":"Delete Availability Schedule","id":"cece66f8-02fd-410d-bb91-f01f5bc5678b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-API-Key","value":"{{apiKey}}","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/availability-schedules/2","urlObject":{"path":["api","admin","availability-schedules","2"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cece66f8-02fd-410d-bb91-f01f5bc5678b"}],"id":"d3f1523b-36ca-4d12-bb7b-8f37166f3936","_postman_id":"d3f1523b-36ca-4d12-bb7b-8f37166f3936","description":""},{"name":"Bookings","item":[{"name":"Booking Reminders","item":[{"name":"Booking Reminders","id":"9fff7aff-810b-4282-80f3-292c54a1c034","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/bookings/reminders","description":"This endpoint retrieves a list of all booking reminders.
\n","urlObject":{"path":["api","admin","bookings","reminders"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9fff7aff-810b-4282-80f3-292c54a1c034"},{"name":"Create Booking Reminder","id":"fd5be4ed-1439-4eeb-bf80-25d15c61f306","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"notification_type\": 1,\n \"time_before_booking\": 60,\n \"recipient_type\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/bookings/reminders","description":"This endpoint creates a new booking reminder with the specified details.
\nExample Body:
\n{\n \"notification_type\": 1,\n \"time_before_booking\": 60,\n \"recipient_type\": 1\n}\n\nnotification_type: This integer value specifies the type of notification to be sent. The possible values are:
\n1: Email
2: SMS
3: Push Notification
time_before_booking: This integer value specifies how many minutes before the booking the reminder should be sent. For example, a value of 60 means the reminder will be sent 60 minutes before the booking.
recipient_type: This integer value specifies the recipient of the notification. The possible values are:
\n1: User
2: Employee
{\n \"id\": 123,\n \"notification_type\": 1,\n \"time_before_booking\": 60,\n \"recipient_type\": 1,\n \"created_at\": \"2024-07-19T12:34:56Z\",\n \"updated_at\": \"2024-07-19T12:34:56Z\"\n}\n\nThis endpoint deletes a booking reminder identified by bookingReminderId. It does not require a body.
Example Usage:
\nDELETE https://api.calendesk.com/api/admin/bookings/reminders/123\n\nThis endpoint allows you to fetch a booking by its id.
This endpoint allows you to fetch bookings. The response is paginated, and you can filter results using the provided parameters.
\nGET https://api.calendesk.com/api/admin/bookings/v2/
GET https://api.calendesk.com/api/admin/bookings/v2/?employee_ids=4,5&user_ids=32&service_ids=47,48&booking_ids=100,101&booking_date_from=2022-05-31&booking_date_to=2022-05-31&create_date_from=2022-06-03&create_date_to=2022-06-05&group_id=abc123
\n","urlObject":{"path":["api","admin","bookings","v2",""],"host":["https://api.calendesk.com"],"query":[{"key":"employee_ids","value":"4,5"},{"key":"user_ids","value":"32"},{"key":"service_ids","value":"47,48"},{"key":"booking_date_from","value":"2022-05-31"},{"key":"booking_date_to","value":"2022-05-31"},{"key":"create_date_from","value":"2022-06-03"},{"key":"create_date_to","value":"2022-06-05"}],"variable":[]}},"response":[],"_postman_id":"9c9c77cd-fae3-4ced-8a57-4656d15b0e32"},{"name":"Group Booking","id":"1186a342-dcf0-4353-8eee-f299f5c389c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/bookings/group/{{multiSlotGroupId}}","description":"This endpoint allows you to fetch bookings. The response will use pagination. You can filter your results using parameters.
\n","urlObject":{"path":["api","admin","bookings","group","{{multiSlotGroupId}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1186a342-dcf0-4353-8eee-f299f5c389c1"},{"name":"Create Booking","id":"d6a0af90-85db-402e-8ef8-863961fcac66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"2024-06-18\",\n \"end_date\": \"2024-06-18\",\n \"employee_id\": 4,\n \"service_id\": 94,\n \"start_time\": \"20:00\",\n \"end_time\": \"20:15\",\n \"user_id\": 1,\n \"service_location_id\": 1,\n \"recurrence_params\": \"RRULE:FREQ=WEEKLY;COUNT=4;INTERVAL=2\",\n \"skip_notifications\": true,\n \"custom_fields\": \"[{\\\"type\\\":1,\\\"label\\\":\\\"Please type here...\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"Additional Information\\\"},{\\\"type\\\":6,\\\"label\\\":null,\\\"description\\\":\\\"Address
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"123 Main Street, Apt 4B, New York, NY 10001, USA\\\"},{\\\"type\\\":0,\\\"label\\\":\\\"Please type here...\\\",\\\"description\\\":\\\"Text Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"Sample text value\\\"},{\\\"type\\\":1,\\\"label\\\":\\\"Please type here...\\\",\\\"description\\\":\\\"Larger Text Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"This is a longer text that spans multiple lines.\\\\nIt can contain paragraphs and more detailed information.\\\"},{\\\"type\\\":2,\\\"label\\\":null,\\\"description\\\":\\\"Checkbox
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":true},{\\\"type\\\":3,\\\"label\\\":null,\\\"description\\\":\\\"Radio Button
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"radioOptions\\\":[\\\"Option 1\\\",\\\"Option 2\\\",\\\"Option 3\\\"],\\\"value\\\":\\\"Option 2\\\"},{\\\"type\\\":4,\\\"label\\\":\\\"Please enter your email...\\\",\\\"description\\\":\\\"Email Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"secondary@example.com\\\"},{\\\"type\\\":5,\\\"label\\\":\\\"Please enter your phone...\\\",\\\"description\\\":\\\"Phone Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"+15551234567\\\"},{\\\"type\\\":7,\\\"label\\\":null,\\\"description\\\":\\\"Attachments Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":[{\\\"2fa02152-beae-40f2-b688-df3216ab6b35\\\":\\\"medical_records.pdf\\\"}]}]\"\n}"},"url":"https://api.calendesk.com/api/admin/bookings","description":"This endpoint allows you to create a booking (make an appointment).
\nEach custom field object in the array has the following structure:
\n[\n {\n \"type\": 1,\n \"label\": \"Please type here...\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"Additional Information\"\n },\n {\n \"type\": 6,\n \"label\": null,\n \"description\": \"Address\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"123 Main Street, Apt 4B, New York, NY 10001, USA\"\n },\n {\n \"type\": 0,\n \"label\": \"Please type here...\",\n \"description\": \"Text Field\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"Sample text value\"\n },\n {\n \"type\": 1,\n \"label\": \"Please type here...\",\n \"description\": \"<p class='preserveHtml' class='preserveHtml'>Larger Text Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"This is a longer text that spans multiple lines.\\nIt can contain paragraphs and more detailed information.\"\n },\n {\n \"type\": 2,\n \"label\": null,\n \"description\": \"<p class='preserveHtml' class='preserveHtml'>Checkbox</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": true\n },\n {\n \"type\": 3,\n \"label\": null,\n \"description\": \"<p class='preserveHtml' class='preserveHtml'>Radio Button</p>\",\n \"required\": false,\n \"equal\": null,\n \"radioOptions\": [\"Option 1\", \"Option 2\", \"Option 3\"],\n \"value\": \"Option 2\"\n },\n {\n \"type\": 4,\n \"label\": \"Please enter your email...\",\n \"description\": \"<p class='preserveHtml' class='preserveHtml'>Email Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"secondary@example.com\"\n },\n {\n \"type\": 5,\n \"label\": \"Please enter your phone...\",\n \"description\": \"<p class='preserveHtml' class='preserveHtml'>Phone Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"+15551234567\"\n },\n {\n \"type\": 7,\n \"label\": null,\n \"description\": \"<p class='preserveHtml' class='preserveHtml'>Attachments Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": [\n {\"2fa02152-beae-40f2-b688-df3216ab6b35\": \"medical_records.pdf\"}\n ]\n }\n ]\n\nImportant Notes:
\nThe entire array must be stringified when sent in the request
\nFile uploads (type 7) require prior upload to the /files/sandbox/upload endpoint
\nThe files are associated with the booking after creation
\nEmpty or null values are allowed for non-required fields
\nThis endpoint allows you to update a booking.
\n","urlObject":{"path":["api","admin","bookings","{{bookingID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"371ccbe4-7bc3-4a3c-8d32-bb8332f6cdc7"},{"name":"Delete Booking","id":"503a724e-6966-485e-aca1-8b2fd33c2cb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/bookings/{{bookingID}}","description":"This endpoint allows you to delete a booking (If you want to cancel a booking, you can also change its status to cancelled, in both cases we send cancel notifications).
\n","urlObject":{"path":["api","admin","bookings","{{bookingID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"503a724e-6966-485e-aca1-8b2fd33c2cb8"},{"name":"Delete Multiple Bookings","id":"77bc712f-98b7-4a75-bfd8-cb0610329bd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"booking_ids\": [\n 3051\n ],\n \"skip_notifications\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/bookings","description":"Delete multiple bookings in a single API call.
\nDELETE https://api.calendesk.com/api/admin/bookings\n\n{\n \"booking_ids\": [\n 3051\n ],\n \"skip_notifications\": true\n}\n\nRequires admin-level authentication
\nBookings are permanently deleted and cannot be recovered
\nPayment refunds must be handled separately if applicable
\nSetting skip_notifications: true prevents automated cancellation emails
This endpoint allows you to resend notifications (email, SMS, push) for a specific booking event. It can be used to trigger notification dispatches for events such as booking creation, updates, or deletion.
\nPOST https://api.calendesk.com/api/admin/bookings/{bookingID}/notifications\n\nPOST https://api.calendesk.com/api/admin/bookings/123/notifications{\n \"event\": 1\n}\n\nHTTP/1.1 200 No Content\n\n{\n \"error\": \"Invalid event type. Accepted values are: created, updated, deleted.\"\n}\n\nThis endpoint allows you to generate file with selected bookings.
\n","urlObject":{"path":["api","admin","bookings","generate","{{type}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c757a35-61e0-432b-b24b-9aa06ee001f2"}],"id":"e92c2b3d-dba6-494e-89bc-0069dadd8bd4","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e6c00901-e34a-45e5-8971-1ae632aeaa3a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"880b4f40-ec9b-4feb-a786-043ba45a77fa","type":"text/javascript","exec":[""]}}],"_postman_id":"e92c2b3d-dba6-494e-89bc-0069dadd8bd4","description":""},{"name":"Bookings - Payment Transactions","item":[{"name":"Payment Transactions","id":"fc5470ce-e054-4dfe-8e4f-534bbefa5203","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/payments/bookings?user_id=8","description":"Endpoint: GET https://api.calendesk.com/api/admin/payments/bookings
Description
\nThis endpoint retrieves booking payment transactions with pagination. The results can be filtered using various parameters.
\nGET https://api.calendesk.com/api/admin/payments/bookings?user_id=8&limit=10&page=1&order_by=id&ascending=1\n\nCode: 200 OK
Content Example:
\n{\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 633,\n \"provider_tag\": \"cash\",\n \"transaction_id\": null,\n \"fakturownia_invoice_id\": null,\n \"promo_code\": null,\n \"invoice_number\": null,\n \"status\": \"paid\",\n \"paid_at\": \"2025-04-11T10:36:00+00:00\",\n \"price\": 10000,\n \"booking\": {\n \"id\": 9254,\n \"user_id\": 19,\n \"employee_id\": 4,\n \"service_id\": 146,\n \"service_type_id\": null,\n \"start_date\": \"2025-04-18\",\n \"end_date\": \"2025-04-18\",\n \"start_time\": \"16:00\",\n \"end_time\": \"17:00\",\n \"starts_at\": \"2025-04-18T14:00:00+00:00\",\n \"ends_at\": \"2025-04-18T15:00:00+00:00\",\n \"customer_time_zone\": null,\n \"group_id\": null,\n \"multi_slot_group_id\": null,\n \"recurrence_params\": null,\n \"status\": \"approved\",\n \"control\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"custom_fields\": null,\n \"paid\": true,\n \"payment_method\": \"cash\",\n \"payment_transaction\": {\n \"id\": 633,\n \"provider_tag\": \"cash\",\n \"transaction_id\": null,\n \"fakturownia_invoice_id\": null,\n \"promo_code\": null,\n \"invoice_number\": null,\n \"status\": \"paid\",\n \"paid_at\": \"2025-04-11T10:36:00+00:00\",\n \"price\": 10000\n },\n \"paid_with_user_subscription_id\": null,\n \"service\": {\n \"id\": 146,\n \"category_id\": 37,\n \"name\": \"Online Consultation\",\n \"description\": null,\n \"upselling_description\": null,\n \"booking_time_before\": 0,\n \"max_booking_time\": 0,\n \"cancel_time_before\": 0,\n \"change_time_before\": 0,\n \"max_people\": 1,\n \"tax\": null,\n \"wants_invoice\": false,\n \"only_subscriptions\": false,\n \"duration\": 60,\n \"slots_every\": 60,\n \"break_time_before\": 0,\n \"break_time_after\": 0,\n \"price\": 10000,\n \"allow_dynamic_duration\": false,\n \"allow_online_payment\": true,\n \"awaiting_booking_payment_time\": 30,\n \"payment_required\": true,\n \"payment_required_recurring_bookings\": true,\n \"status\": \"active\",\n \"order_position\": \"1048560\",\n \"default_booking_status\": \"approved\",\n \"default_image\": null,\n \"category\": {\n \"id\": 37,\n \"name\": \"Consultations\",\n \"status\": \"active\",\n \"order_position\": \"65535\"\n },\n \"employees\": [\n {\n \"id\": 47,\n \"title\": null,\n \"description\": null,\n \"facebook\": null,\n \"instagram\": null,\n \"youtube\": null,\n \"twitter\": null,\n \"user\": {\n \"id\": 766,\n \"name\": \"Jane\",\n \"surname\": \"Doe\",\n \"status\": \"active\",\n \"default_image\": {\n \"id\": 6302,\n \"name\": \"/calendesk/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/xxxxxxxxxx.jpg\",\n \"user_image_id\": 1119\n }\n },\n \"services\": []\n },\n {\n \"id\": 4,\n \"title\": \"Consultant\",\n \"description\": \"Professional consultant with expertise in various fields\",\n \"facebook\": \"https://www.facebook.com/\",\n \"instagram\": \"https://www.instagram.com/\",\n \"youtube\": \"https://www.linkedin.com/\",\n \"twitter\": null,\n \"user\": {\n \"id\": 1,\n \"name\": \"John\",\n \"surname\": \"Smith\",\n \"status\": \"active\",\n \"default_image\": {\n \"id\": 9345,\n \"name\": \"/calendesk/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/xxxxxxxxxx.jpg\",\n \"user_image_id\": 1249\n }\n },\n \"services\": []\n }\n ],\n \"types\": [],\n \"locations\": [\n {\n \"id\": 577,\n \"type\": 3,\n \"data\": null,\n \"name\": null,\n \"location_id\": 3\n }\n ],\n \"durations_range\": {\n \"from\": 60,\n \"to\": 60\n },\n \"prices_range\": {\n \"from\": 10000,\n \"to\": 10000\n }\n },\n \"service_type\": null,\n \"employee\": {\n \"id\": 4,\n \"title\": \"Consultant\",\n \"description\": \"Professional consultant with expertise in various fields\",\n \"facebook\": \"https://www.facebook.com/\",\n \"instagram\": \"https://www.instagram.com/\",\n \"youtube\": \"https://www.linkedin.com/\",\n \"twitter\": null,\n \"user\": {\n \"id\": 1,\n \"name\": \"John\",\n \"surname\": \"Smith\",\n \"status\": \"active\",\n \"default_image\": {\n \"id\": 9345,\n \"name\": \"/calendesk/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/xxxxxxxxxx.jpg\",\n \"user_image_id\": 1249\n }\n },\n \"services\": [\n {\n \"id\": 150,\n \"name\": \"Group Session\"\n },\n {\n \"id\": 146,\n \"name\": \"Online Consultation\"\n }\n ]\n },\n \"location\": {\n \"id\": 577,\n \"type\": 3,\n \"data\": null,\n \"name\": null,\n \"location_id\": 3\n },\n \"google_meet_url\": \"https://meet.google.com/xxx-xxxx-xxx\",\n \"zoom_join_url\": null,\n \"teams_url\": null,\n \"skype_url\": null,\n \"customer_whatsapp_url\": null,\n \"employee_whatsapp_url\": null,\n \"simple_store_products\": []\n }\n }\n ],\n \"first_page_url\": \"https://api.calendesk.com/api/admin/payments/bookings?page=1&limit=50\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"https://api.calendesk.com/api/admin/payments/bookings?page=1&limit=50\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://api.calendesk.com/api/admin/payments/bookings?page=1&limit=50\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": null,\n \"path\": \"https://api.calendesk.com/api/admin/payments/bookings\",\n \"per_page\": 50,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n}\n\nThe response is paginated and includes:
\ncurrent_page: Current page number
first_page_url: URL for the first page
from: Starting record index on current page
last_page: Last page number
last_page_url: URL for the last page
links: Array of pagination links
next_page_url: URL for the next page (null if on last page)
path: Base path for API endpoint
per_page: Number of records per page
prev_page_url: URL for the previous page (null if on first page)
to: Ending record index on current page
total: Total number of records
Each item in the data array includes:
id: Transaction ID
provider_tag: Payment provider identifier
transaction_id: External transaction ID
fakturownia_invoice_id: Invoice ID in the Fakturownia system
promo_code: Applied promotion code
invoice_number: Invoice number
status: Payment status
paid_at: Payment timestamp (ISO 8601 format)
price: Payment amount in smallest currency unit
booking: Related booking information
Endpoint: POST https://api.calendesk.com/api/admin/payments/bookings
Description
\nThis endpoint allows administrators to create payment transactions for bookings. It handles payment processing, status updates, and can generate invoices if configured.
\n* Required when not using user_subscription_id
{\n \"booking_id\": 4395,\n \"payment_method\": \"cash\",\n \"transaction_id\": \"Test\",\n \"amount\": 20000,\n \"status\": \"approved\",\n \"is_paid\": true\n}\n\nCode: 201 Created
Content: Payment transaction resource object
\nstripe // Stripe payment processor\ncard // Credit/debit card\ncash // Cash payment\ntransfer // Bank transfer\nother // Other payment methods\nsubscription // Subscription-based payment\n\nwaiting // Booking is waiting for confirmation\npayment // Booking requires payment\napproved // Booking has been approved\ncancelled // Booking has been cancelled\ndone // Booking has been completed\n\nWhen successful, the endpoint will:
\nCreate or update a payment transaction
\nUpdate the booking status
\nProcess associated simple store products if provided
\nGenerate invoices if configured
\nThis endpoint allows you to fetch booking payment transactions. The response will use pagination. You can filter your results using parameters.
\n","urlObject":{"path":["api","admin","payments","bookings","218"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"eeb10892-1cef-412c-9bb1-6492128d8cf3"}],"id":"f12dedd1-f6b8-4373-875f-1ff216ac9853","event":[{"listen":"prerequest","script":{"id":"30f943a9-e199-4445-894a-7252cd241bc5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1fbbf266-cb63-4891-8bf3-e35aca3038cf","type":"text/javascript","exec":[""]}}],"_postman_id":"f12dedd1-f6b8-4373-875f-1ff216ac9853","description":""},{"name":"Categories","item":[{"name":"Category","id":"551f0afd-9347-40a6-b1c4-1c34caf7096e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/categories/{{categoryID}}","description":"This endpoint allows you to fetch a category by its id.
This endpoint allows you to fetch categories. The response will use pagination.
\n","urlObject":{"path":["api","admin","categories"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0b9c70da-2521-4a09-ab46-63a6f555b969"},{"name":"Categories With Services","id":"3afc2a4e-4aa9-4418-953d-82cce430ee25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/v2/categories/services","description":"This endpoint allows you to fetch all categories with all services. You can filter the response with the query and status parameters.
This endpoint allows you to create a new category.
\n","urlObject":{"path":["api","admin","categories"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"aca9c281-c5fb-41aa-ad29-ca7d4e70912f"},{"name":"Update Category","id":"69207496-9b0b-453a-8ef7-7131da868862","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"status\" : \"inactive\",\n\t\"order_position\" : 15000.875,\n\t\"default_image_id\" : 11\n}"},"url":"https://api.calendesk.com/api/admin/categories/{{categoryID}}","description":"This endpoint allows you to update a category.
\n","urlObject":{"path":["api","admin","categories","{{categoryID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"69207496-9b0b-453a-8ef7-7131da868862"},{"name":"Upload Categorie's Picture","id":"08e23551-72c6-4212-a7f9-ef4cdd1c8917","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","value":null}]},"url":"https://api.calendesk.com/api/admin/categories/{{categoryID}}/upload/picture","description":"This endpoint allows you to add a picture to category.
\nThis request will remove the old picture and will set the new one as a default.
\nRemember about setting Conent-Type to application/x-www-form-urlencoded.
\nThe default limit is 10240 KB, the size will be limited to 600x600 px.
This endpoint allows you to delete a category.
This endpoint allows you to fetch company working hours.
\n","urlObject":{"path":["api","admin","company-working-hours"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"56911b69-a517-4d22-9c1f-20c056a08787"},{"name":"Update Company Working Hours","id":"bbac8f9c-3c01-4983-83eb-6852b6a286de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"days\": [\n {\n \"day\": \"monday\",\n \"open\": \"08:00\",\n \"close\": \"17:00\",\n \"is_open\": true\n },\n {\n \"day\": \"tuesday\",\n \"open\": \"08:00\",\n \"close\": \"17:00\",\n \"is_open\": true\n },\n {\n \"day\": \"wednesday\",\n \"open\": \"08:00\",\n \"close\": \"17:00\",\n \"is_open\": true\n },\n {\n \"day\": \"thursday\",\n \"open\": \"08:00\",\n \"close\": \"17:00\",\n \"is_open\": true\n },\n {\n \"day\": \"friday\",\n \"open\": \"08:00\",\n \"close\": \"20:00\",\n \"is_open\": true\n },\n {\n \"day\": \"saturday\",\n \"open\": \"08:00\",\n \"close\": \"17:00\",\n \"is_open\": true\n },\n {\n \"day\": \"sunday\",\n \"is_open\": false\n }\n ]\n}"},"url":"https://api.calendesk.com/api/admin/company-working-hours","description":"This endpoint allows you to update company working hours. This call will replace only days you are sending.
\n","urlObject":{"path":["api","admin","company-working-hours"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bbac8f9c-3c01-4983-83eb-6852b6a286de"}],"id":"f252b2f7-a15a-4086-91fd-2edb63e6dde3","event":[{"listen":"prerequest","script":{"id":"4182b688-b483-49dc-9123-f7b53df073df","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d76d6002-c60a-4113-8590-42995784db40","type":"text/javascript","exec":[""]}}],"_postman_id":"f252b2f7-a15a-4086-91fd-2edb63e6dde3","description":""},{"name":"Domains","item":[{"name":"Get Available Domains","id":"e8076449-c9d3-4999-90d5-26dc10f2ab63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/domains/available","urlObject":{"path":["api","admin","domains","available"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e8076449-c9d3-4999-90d5-26dc10f2ab63"},{"name":"Get Tenants Domains","id":"3080c347-5458-42e1-9229-9388703f0b53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","type":"text","value":"{{apiKey}}"}],"url":"https://api.calendesk.com/api/admin/domains","urlObject":{"path":["api","admin","domains"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3080c347-5458-42e1-9229-9388703f0b53"},{"name":"Assign Domain to Tenant","id":"62043ee6-5277-48d8-8986-4c508b79bc20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"domain\" : \"https://mycalendar.com\",\n \"calendar_id\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/domains","urlObject":{"path":["api","admin","domains"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"62043ee6-5277-48d8-8986-4c508b79bc20"},{"name":"Update Tenants Domain","id":"bb9ba661-7bec-48f8-b4b4-45c82fd167e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"domain\" : \"https://mydomain.calendesk.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/domains/{{domainId}}","urlObject":{"path":["api","admin","domains","{{domainId}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb9ba661-7bec-48f8-b4b4-45c82fd167e5"},{"name":"Delete Tenants Domain","id":"3c13daea-56fd-469d-b5a0-c9c55f3f914a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","type":"text","value":"{{apiKey}}"}],"url":"https://api.calendesk.com/api/admin/domains/1","urlObject":{"path":["api","admin","domains","1"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3c13daea-56fd-469d-b5a0-c9c55f3f914a"}],"id":"2e666a89-22fe-4b21-9d23-f038f16e6070","_postman_id":"2e666a89-22fe-4b21-9d23-f038f16e6070","description":""},{"name":"Employees","item":[{"name":"Employee","id":"f3ad32da-51c2-4795-8042-0d6bef95cbc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/employees/{{employeeID}}","description":"This endpoint allows you to fetch an employee by its id.
This endpoint allows you to fetch employees. The response will use pagination.
\n","urlObject":{"path":["api","admin","employees"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"be5e4220-05e2-41a8-95d5-89e7b12d4fe7"},{"name":"Create Employee","id":"62b212c2-90dc-4eda-8440-46440c74ee8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Szymon\",\n \"surname\": \"Zawodowiec\",\n \"email\": \"szymon2@calendesk.com\",\n \"password\": \"demo12345\",\n \"generate_password\": true,\n \"role_ids\": [\n 2\n ],\n \"status\": \"active\",\n \"default_phone\": \"+48500111222\",\n \"date_of_birth\": \"2019-01-03\",\n \"date_of_names_day\": \"2019-01-02\",\n \"gender\": \"male\",\n \"identity_number\": \"1234\",\n \"card_number\": \"123456666\",\n \"tags\": [],\n \"is_public\": true,\n \"default_image_id\" : 11,\n \"service_ids\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"default_address\": {\n \"street\": \"Zawodowiec Street\",\n \"postal_code\": \"00-000\",\n \"city\": \"Warszawa\",\n \"country_iso_code\": \"pl\"\n },\n \"social_1\": \"https://facebook.com\",\n \"social_2\": \"https://instagram.com\",\n \"social_3\": \"https://pinterest.com\",\n \"title\": \"Specjalista\",\n \"color\": \"#69ba00\",\n \"description\": \"Niezastąpiony i niezawodny w każdym calu. Szymon to urodzony specjalista!\",\n \"days\": [\n {\n \"day\": \"monday\",\n \"start_time\": \"07:00\",\n \"end_time\": \"18:00\"\n },\n {\n \"day\": \"tuesday\",\n \"start_time\": \"07:00\",\n \"end_time\": \"15:00\"\n },\n {\n \"day\": \"wednesday\",\n \"start_time\": \"07:00\",\n \"end_time\": \"23:00\"\n },\n {\n \"day\": \"thursday\",\n \"start_time\": \"07:00\",\n \"end_time\": \"22:00\"\n },\n {\n \"day\": \"friday\",\n \"start_time\": \"07:00\",\n \"end_time\": \"11:00\"\n }\n ]\n}"},"url":"https://api.calendesk.com/api/admin/employees","description":"This endpoint allows you to create a new employee. The employee will be created with user's account as well. Each employee needs a user account which will be able to login to the user's panel (website for tenant's clients) and mobile app (mobile app for tenant's clients).\nThe same user can also receive permission to the admin's panel (admin panel for tenant's).
\nYou can give permissions to the user also in this request.
This endpoint allows you to update an employee. This request will update its user's account as well.
\n","urlObject":{"path":["api","admin","employees","{{employeeID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"74374e9f-dba4-4512-ad68-c916148023f9"},{"name":"Update Employee (itself)","id":"0a5b2418-ec66-42ff-ba9f-116fc1a8fa96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"default_image_id\": 12,\n \"status\": \"active\",\n \"gender\": \"male\",\n \"description\": \"Andrzej jest świetnym managerem i niezastąpionym fryzjerem.\",\n \"services\": [\n 1\n ],\n \"role_ids\": [\n 2\n ],\n \"days\": [\n {\n \"day\": \"monday\",\n \"start_time\": \"07:00\",\n \"end_time\": \"22:00\"\n },\n {\n \"day\": \"tuesday\",\n \"start_time\": \"07:00\",\n \"end_time\": \"22:00\"\n },\n {\n \"day\": \"wednesday\",\n \"start_time\": \"07:00\",\n \"end_time\": \"23:00\"\n },\n {\n \"day\": \"thursday\",\n \"start_time\": \"07:00\",\n \"end_time\": \"22:00\"\n },\n {\n \"day\": \"friday\",\n \"start_time\": \"07:00\",\n \"end_time\": \"11:00\"\n }\n ]\n}"},"url":"https://api.calendesk.com/api/admin/employee","description":"This endpoint allows you to update an employee. This request will update its user's account as well.
\n","urlObject":{"path":["api","admin","employee"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0a5b2418-ec66-42ff-ba9f-116fc1a8fa96"},{"name":"Delete Employee","id":"e0819d38-ae2b-464f-8c37-19ef2bcbcdd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/employees/{{employeeID}}","description":"This endpoint allows you to delete a employee. This request won't remove its user's accunt.
This API endpoint allows you to get all the events including bookings, group bookings, and blackout dates (unavailable booking slots).
\nEndpoint: GET /api/admin/events
The with parameter allows you to include related entities in the response by specifying their keys. Each key maps to a specific relation in the codebase. Here's what each key represents:
bpt: Booking Payment Transactionsprods: Productsppt: Product Payment Transactionsserv: Serviceusr: Useremp: Employeetags: Tagsug: User Groupsup: User Phoneua: User Addressui: User ImageFor instance, if you want to include the related \"service\" and \"employee\" in the response, you would set the with parameter to serv,emp. If you wish to include all related entities, you would set the with parameter to bpt,prods,ppt,serv,usr,emp,tags,ug,up,ua,ui.
This API endpoint determines if a proposed booking or unavailable booking slot will overlap with existing bookings or unavailable slots. It supports both individual services and group services with capacity constraints.
\nEndpoint: POST https://api.calendesk.com/api/admin/events/check-overlaps
The API implements the following business logic to check for overlaps when creating or updating bookings or unavailable slots:
\nIndividual vs Group Services:
\nFor individual services, any existing booking in a timeslot makes it unavailable
\nFor group services, a timeslot remains available until the group capacity is reached (controlled by the service's max_people setting)
Group Service Availability Rules:
\nIf bookings for the same service in the requested timeslot are less than the service's max_people setting AND there are no bookings for other services, the timeslot is available
If the group is full, other services are booked during that time, or there are surrounding bookings that would be enclosed by the new booking, the timeslot is unavailable
\nTime Overlap Conditions:
\nCase 1: Entity starts during the requested time range
\nCase 2: Entity ends during the requested time range
\nCase 3: Entity completely surrounds the requested time range
\nCase 4: Requested time range completely surrounds the entity
\nRecurring Events Handling:
\nThe API supports checking overlaps for recurring events
\nIt calculates all occurrence dates based on the provided RRULE
\nEach occurrence is individually checked for overlaps
\nIf an error occurs in parsing the recurrence rule, the API falls back to checking just the first date
\nUnavailable Slots Handling:
\nThe API checks for overlaps with both employee-specific and global unavailable slots
\nGlobal slots (with employee_id as null) apply to all employees
{\n \"start_date\": \"2025-04-15\",\n \"end_date\": \"2025-04-15\",\n \"employee_id\": 4,\n \"start_time\": \"14:30\",\n \"end_time\": \"18:01\",\n \"recurrence_params\": \"FREQ=DAILY;INTERVAL=1;COUNT=10\",\n \"all_day_event\": false,\n \"service_id\": 150\n}\n\n{\n \"has_overlaps\": true,\n \"unavailable_occurrences\": [\n {\n \"date\": \"2025-04-15\",\n \"time\": \"14:30\",\n \"formatted\": \"wtorek, 15 kwietnia 2025 o 14:30\",\n \"booking_overlaps\": 6,\n \"unavailable_slot_overlaps\": 1,\n \"blocking_bookings\": [\n {\n \"id\": 9261,\n \"service_name\": \"Test\",\n \"service_id\": 150,\n \"start_date\": \"2025-04-15\",\n \"end_date\": \"2025-04-15\",\n \"start_time\": \"17:00\",\n \"end_time\": \"17:30\",\n \"formatted\": \"wtorek, 15 kwietnia 2025 o 17:00\",\n \"customer_name\": \"Anna\",\n \"is_group\": true,\n \"max_people\": 5\n },\n // Additional booking entries...\n ],\n \"blocking_unavailable_slots\": [\n {\n \"id\": 152781,\n \"description\": \"Blokada kalendarza Calendesk\",\n \"start_date\": \"2025-04-15\",\n \"end_date\": \"2025-04-15\",\n \"start_time\": \"14:30\",\n \"end_time\": \"16:00\",\n \"formatted\": \"wtorek, 15 kwietnia 2025 o 14:30\"\n }\n ]\n },\n {\n \"date\": \"2025-04-16\",\n \"time\": \"14:30\",\n \"formatted\": \"środa, 16 kwietnia 2025 o 14:30\",\n \"booking_overlaps\": 0,\n \"unavailable_slot_overlaps\": 1,\n \"blocking_bookings\": [],\n \"blocking_unavailable_slots\": [\n {\n \"id\": 152654,\n \"description\": \"Blokada kalendarza Calendesk\",\n \"start_date\": \"2025-04-16\",\n \"end_date\": \"2025-04-16\",\n \"start_time\": \"14:30\",\n \"end_time\": \"15:30\",\n \"formatted\": \"środa, 16 kwietnia 2025 o 14:30\"\n }\n ]\n },\n // Additional unavailable occurrences...\n ],\n \"total_occurrences\": 10,\n \"unavailable_count\": 6,\n \"rule_error\": null\n}\n\nThis API endpoint allows you to export a file in a specific type with all the selected events.
\nEndpoint: POST /api/admin/events/generate/{type}
The {type} parameter in the URL should be replaced with the desired export file type.
Note: You need to have the permissions to show bookings and unavailable booking slots to use this endpoint.
\n","urlObject":{"path":["api","admin","bookings","generate","{{type}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef8ff7fd-69fa-4c7b-9155-568906c707f6"}],"id":"ec2445f5-f919-42eb-b8bb-2ef895200bf7","_postman_id":"ec2445f5-f919-42eb-b8bb-2ef895200bf7","description":""},{"name":"Groups","item":[{"name":"Group","id":"ff2dc3a4-b3fe-4244-9bad-2befbca529c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/groups/{{groupID}}","description":"This endpoint allows you to fetch a group by its id.
This endpoint allows you to fetch groups. The response will use pagination.
\n","urlObject":{"path":["api","admin","groups"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f828afb-562a-42b2-805e-35998324de3b"},{"name":"Create Group","id":"b4d72a88-e3a5-41b7-a859-bf37b757f9da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\" : \"New group\"\n}"},"url":"https://api.calendesk.com/api/admin/groups","description":"This endpoint allows you to create a new group.
\n","urlObject":{"path":["api","admin","groups"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b4d72a88-e3a5-41b7-a859-bf37b757f9da"},{"name":"Update Group","id":"dbdc7415-d36e-4554-853d-7564a091c7f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\" : \"Updated group\"\n}"},"url":"https://api.calendesk.com/api/admin/groups/{{groupID}}","description":"This endpoint allows you to update a group.
\n","urlObject":{"path":["api","admin","groups","{{groupID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dbdc7415-d36e-4554-853d-7564a091c7f6"},{"name":"Delete Group","id":"92763d41-db11-47db-8c41-c06bbc61fce3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.calendesk.com/api/admin/groups/{{groupID}}","description":"This endpoint allows you to delete a group.
This endpoint allows you to check if the API is healthy.
\n","urlObject":{"path":["api","healthy","tenant"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4c2634c-8279-4c04-b7ba-5ae06508a86e"},{"name":"Healthy Central","id":"51a3d613-a907-4f33-b4ec-e4be50246dd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"}],"url":"https://api.calendesk.com/api/healthy/central","description":"This endpoint allows you to check if the API is healthy.
\n","urlObject":{"path":["api","healthy","central"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"51a3d613-a907-4f33-b4ec-e4be50246dd2"}],"id":"feeede7c-aaa6-4ca6-8b56-e734caebe641","event":[{"listen":"prerequest","script":{"id":"4b209785-0822-438a-887e-588cca196c34","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c49f105c-5c9d-4488-a318-ae5b6520d268","type":"text/javascript","exec":[""]}}],"_postman_id":"feeede7c-aaa6-4ca6-8b56-e734caebe641","description":""},{"name":"Import Data","item":[{"name":"Import Users","id":"2286a0ed-69f4-47a1-9f13-2c8541f6617b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/maciejcupial/Downloads/import_users_example.xlsx"],"value":null}]},"url":"https://api.calendesk.com/api/admin/import/users","description":"This endpoint enables you to import user data.
\nDownload the required file format template: import_users_example.xlsx
\nEnsure that Content-Type is set to application/x-www-form-urlencoded.
Maximum upload file size: 10 MB (10240 KB)
The following columns are accepted in the uploaded file. All fields are optional, but for a valid import, at least name, surname, email, or identity_number must be provided.
\nThis endpoint enables you to import booking data.
\nImported bookings will not trigger any notifications and are not synced with employee calendars. This import function is intended solely for viewing historical booking data within the system.
\nEnsure that Content-Type is set to application/x-www-form-urlencoded.
Download the required file format template: import_bookings_example.xlsx
\nMaximum upload file size: 10 MB (10240 KB)
The following columns are accepted in the uploaded file. All fields are optional, but the file must meet specific data formatting requirements for successful import.
\nThis endpoint allows you to fetch issued invoices.
\n","urlObject":{"path":["api","admin","invoices"],"host":["https://api.calendesk.com"],"query":[{"key":"query","value":"CD-02"},{"key":"created_from","value":"2022-01-11"},{"key":"created_to","value":"2022-01-13"}],"variable":[]}},"response":[],"_postman_id":"ff3dd2ad-337f-4245-86ad-f5f474007d1b"},{"name":"Downloade Issued Invoice PDF","id":"553e6826-413c-40cc-afc6-c42e6dd94915","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/invoices/fakturownia/pdf/{{invoiceId}}","description":"This endpoint allows you to fetch issued invoices.
\n","urlObject":{"path":["api","admin","invoices","fakturownia","pdf","{{invoiceId}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"553e6826-413c-40cc-afc6-c42e6dd94915"}],"id":"5fbd9066-6b62-4fad-8c30-ef460e535e88","_postman_id":"5fbd9066-6b62-4fad-8c30-ef460e535e88","description":""},{"name":"Newsletter","item":[{"name":"Newsletter","id":"da4398ce-8b07-4861-9f66-05df06ac7141","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/newsletter?is_valid=1","urlObject":{"path":["api","admin","newsletter"],"host":["https://api.calendesk.com"],"query":[{"key":"is_valid","value":"1"}],"variable":[]}},"response":[],"_postman_id":"da4398ce-8b07-4861-9f66-05df06ac7141"},{"name":"Newsletter generate file","id":"298b570b-d487-43d7-882c-b5ae4b4ef0d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"newsletter_ids\": [\n 42,\n 43\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/newsletter/generate/{{type}}","description":"This endpoint allows you to generate file with selected newsletter records.
\n","urlObject":{"path":["api","admin","newsletter","generate","{{type}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"298b570b-d487-43d7-882c-b5ae4b4ef0d7"},{"name":"Newsletter (single)","id":"ec15fe79-9e6c-40e5-9b25-5efdc7abb7e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/newsletter/16","urlObject":{"path":["api","admin","newsletter","16"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec15fe79-9e6c-40e5-9b25-5efdc7abb7e1"},{"name":"Create Newsletter","id":"65d6ede3-a363-4c8a-93b0-b730f5321ccf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\" : \"jan@calendesk.com\",\n \"is_valid\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/newsletter","urlObject":{"path":["api","admin","newsletter"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"65d6ede3-a363-4c8a-93b0-b730f5321ccf"},{"name":"Update Newsletter","id":"2986c48c-c8e7-4407-abb5-4867f288e848","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\" : \"jan@calendesk.com\",\n \"is_valid\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/newsletter/16","urlObject":{"path":["api","admin","newsletter","16"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2986c48c-c8e7-4407-abb5-4867f288e848"},{"name":"Delete Newsletter","id":"21e9eb5a-cd51-4cbc-bf57-01353bd5832d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/newsletter/1","urlObject":{"path":["api","admin","newsletter","1"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"21e9eb5a-cd51-4cbc-bf57-01353bd5832d"},{"name":"Delete Multiple Newsletter","id":"2216bdb0-9d83-49f9-a5ca-d7f6d595eebb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"newsletter_ids\" : [\n 15\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/newsletter","urlObject":{"path":["api","admin","newsletter"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2216bdb0-9d83-49f9-a5ca-d7f6d595eebb"}],"id":"a3141053-2c6a-4eff-8284-6f237fb51da2","event":[{"listen":"prerequest","script":{"id":"54f53795-ba71-477f-8d04-6850fe88ae65","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a76ac22d-7383-4a03-84a1-59fd3ff7cdbd","type":"text/javascript","exec":[""]}}],"_postman_id":"a3141053-2c6a-4eff-8284-6f237fb51da2","description":""},{"name":"Notifications","item":[{"name":"Templates","item":[{"name":"Get Notification Templates","id":"ce6ea5e4-60fd-421b-a8b3-cb5c48bb6e1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/notifications/templates","description":"This endpoint allows you to create a mobile editor draft.
\n","urlObject":{"path":["api","admin","notifications","templates"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce6ea5e4-60fd-421b-a8b3-cb5c48bb6e1c"},{"name":"Get Notification Template Types","id":"f78720f1-3030-4f3c-a7eb-ce6ccaa09e12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/notifications/templates/types","description":"This endpoint allows you to create a mobile editor draft.
\n","urlObject":{"path":["api","admin","notifications","templates","types"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f78720f1-3030-4f3c-a7eb-ce6ccaa09e12"},{"name":"Create Notification Template","id":"9e64375a-d7ac-4483-9061-1fffe45b86be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type_id\": 9,\n \"subject\": \"Zmiana rezerwacji: [EMPLOYEE_NAME] [EMPLOYEE_SURNAME]\",\n \"content\": \"email.booking.created.client: [EMPLOYEE_NAME] [EMPLOYEE_SURNAME] [EMPLOYEE_FULL_NAME] [CUSTOMER_FULL_NAME] [CUSTOMER_NAME] [CUSTOMER_SURNAME] [BOOKING_START_DATE] [BOOKING_START_TIME] [BOOKING_END_DATE] [BOOKING_END_TIME] [SERVICE_NAME] [BOOKING_PRICE] [COMPANY_NAME] [COMPANY_PHONE] [COMPANY_ADDRESS] [BOOKING_STATUS]\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/notifications/templates","description":"{\n \"type_id\": 8,\n \"subject\": \"email.booking.reminder.client: %EMPLOYEE_NAME% %EMPLOYEE_SURNAME%\",\n \"content\": \"email.booking.reminder.client: %EMPLOYEE_NAME% %EMPLOYEE_SURNAME% %EMPLOYEE_FULL_NAME% %CUSTOMER_FULL_NAME% %CUSTOMER_NAME% %CUSTOMER_SURNAME% %BOOKING_START_DATE% %BOOKING_START_TIME% %BOOKING_END_DATE% %BOOKING_END_TIME% %SERVICE_NAME% %PRICE% %COMPANY_NAME% %COMPANY_PHONE% %COMPANY_ADDRESS% %STATUS%\"\n}
\n","urlObject":{"path":["api","admin","notifications","templates"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9e64375a-d7ac-4483-9061-1fffe45b86be"},{"name":"Update Notification Template","id":"5209d440-f31d-4927-90c2-9d8474dd1751","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","type":"text","value":"{{apiKey}}"}],"body":{"mode":"raw","raw":"{\n \"subject\": \"Zmiana rezerwacji: [EMPLOYEE_NAME] [EMPLOYEE_SURNAME]\",\n \"content\": \"email.booking.created.client: [EMPLOYEE_NAME] [EMPLOYEE_SURNAME] [EMPLOYEE_FULL_NAME] [CUSTOMER_FULL_NAME] [CUSTOMER_NAME] [CUSTOMER_SURNAME] [BOOKING_START_DATE] [BOOKING_START_TIME] [BOOKING_END_DATE] [BOOKING_END_TIME] [SERVICE_NAME] [PRICE] [COMPANY_NAME] [COMPANY_PHONE] [COMPANY_ADDRESS] [STATUS]\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/notifications/templates/2","description":"This endpoint allows you to create a mobile editor draft.
\n","urlObject":{"path":["api","admin","notifications","templates","2"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5209d440-f31d-4927-90c2-9d8474dd1751"},{"name":"Delete Notification Template","id":"cfd13ba3-4253-4206-883a-87e363712405","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","type":"text","value":"{{apiKey}}"}],"url":"https://api.calendesk.com/api/admin/notifications/templates/9","description":"This endpoint allows you to create a mobile editor draft.
\n","urlObject":{"path":["api","admin","notifications","templates","9"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cfd13ba3-4253-4206-883a-87e363712405"}],"id":"7c4b2717-fafa-44bf-a2d4-dd9378812fa1","_postman_id":"7c4b2717-fafa-44bf-a2d4-dd9378812fa1","description":""},{"name":"Customer Notifications","item":[{"name":"Contact Tenant From Website","id":"8bc151e0-cb42-4a4d-92ed-9680a68b57af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer_type\" : 1,\n \"notification_type\" : 3,\n \"customer_ids\": [2,3],\n \"subject\": \"Test subject\",\n \"html_content\": \"Test content\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/mail/tenant/send","description":"This endpoint allows you to send a notification to a specific type of customer (User, Newsletter, Employee) via different channels (Email, SMS, Push). The notification can be personalized with a subject and a message content.
\nPOST https://api.calendesk.com/api/admin/customer-notifications
\n{ \"customer_type\" : 1, \"notification_type\" : 3, \"customer_ids\": [2,3], \"subject\": \"AAAA\", \"content\": \"Test text\" }
\nOn success, the API will return a 200 OK status. The response will include the IDs of the customers who received the notification.
\nOn failure, the API will return an error message detailing what went wrong. Possible errors include invalid customer type, invalid notification type, missing or invalid customer IDs, or missing content.
\n","urlObject":{"path":["api","mail","tenant","send"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8bc151e0-cb42-4a4d-92ed-9680a68b57af"},{"name":"Customer Notification","id":"9026fdd0-6e5d-4e88-bb95-94228645ba27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/customer-notifications?date=2021-03-26,2021-03-27","urlObject":{"path":["api","admin","customer-notifications"],"host":["https://api.calendesk.com"],"query":[{"key":"date","value":"2021-03-26,2021-03-27"}],"variable":[]}},"response":[],"_postman_id":"9026fdd0-6e5d-4e88-bb95-94228645ba27"}],"id":"ea4b9207-0cb6-4b50-b4c7-ba92ab13c898","_postman_id":"ea4b9207-0cb6-4b50-b4c7-ba92ab13c898","description":""}],"id":"634698a3-f808-43fc-8e77-b5987d8f180d","_postman_id":"634698a3-f808-43fc-8e77-b5987d8f180d","description":""},{"name":"Photos","item":[{"name":"Search for photos","id":"ceeda35e-dcdb-4256-961c-cfd090ebcb5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Api-Key","type":"text","value":"{{apiKey}}"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"}],"url":"https://api.calendesk.com/api/admin/photos/unsplash/search?query=hair","description":"This endpoint allows you to search for photos.
\n","urlObject":{"path":["api","admin","photos","unsplash","search"],"host":["https://api.calendesk.com"],"query":[{"key":"query","value":"hair"}],"variable":[]}},"response":[],"_postman_id":"ceeda35e-dcdb-4256-961c-cfd090ebcb5a"},{"name":"Select photo","id":"44a0adc1-2859-49b6-8891-072edaad2810","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Api-Key","type":"text","value":"{{apiKey}}"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"}],"url":"https://api.calendesk.com/api/admin/photos/unsplash/select?id=WCPg9ROZbM0","description":"This endpoint allows you to download photo and put it in users image.
\n","urlObject":{"path":["api","admin","photos","unsplash","select"],"host":["https://api.calendesk.com"],"query":[{"key":"id","value":"WCPg9ROZbM0"}],"variable":[]}},"response":[],"_postman_id":"44a0adc1-2859-49b6-8891-072edaad2810"}],"id":"cabfc5bd-1a7f-422a-84d2-00549d55882e","_postman_id":"cabfc5bd-1a7f-422a-84d2-00549d55882e","description":""},{"name":"Resources","item":[{"name":"Resource","id":"d43ce5dc-1ed3-47f4-aa13-1551243831fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/resources/{{resourceID}}","description":"This endpoint allows you to fetch a reource by its id.
This endpoint allows you to fetch resources. The response will use pagination.
\n","urlObject":{"path":["api","admin","resources"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"010f2443-5837-4cd2-949c-37fd338e8f0f"},{"name":"Create Resource","id":"bc39d72b-fd24-46cb-8ece-bd6869331efd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\" : \"Stolik duży\",\n\t\"quantity\" : 5\n}"},"url":"https://api.calendesk.com/api/admin/resources","description":"This endpoint allows you to create a new resource.
\n","urlObject":{"path":["api","admin","resources"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc39d72b-fd24-46cb-8ece-bd6869331efd"},{"name":"Update Resource","id":"09d26b4a-26c9-4194-8e81-643a0a70fe06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"quantity\" : 99\n}"},"url":"https://api.calendesk.com/api/admin/resources/{{resourceID}}","description":"This endpoint allows you to update a resource.
\n","urlObject":{"path":["api","admin","resources","{{resourceID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"09d26b4a-26c9-4194-8e81-643a0a70fe06"},{"name":"Delete Resource","id":"391e4d44-c0ce-46d9-b81c-276f2da77eb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.calendesk.com/api/admin/resources/{{resourceID}}","description":"This endpoint allows you to delete a service type.
\n","urlObject":{"path":["api","admin","resources","{{resourceID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"391e4d44-c0ce-46d9-b81c-276f2da77eb2"}],"id":"b1137e95-9b6e-4124-a7b8-4ddef9578c7b","_postman_id":"b1137e95-9b6e-4124-a7b8-4ddef9578c7b","description":""},{"name":"Roles and Permissions","item":[{"name":"Roles","id":"0288dd0c-b456-450b-b1d3-59c610e5d754","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/roles","description":"This endpoint allows you to fetch roles. The response will use pagination.
\n","urlObject":{"path":["api","admin","roles"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0288dd0c-b456-450b-b1d3-59c610e5d754"},{"name":"Permissions","id":"e1b00bc4-2db2-4beb-b552-d31fe48c25f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/permissions","description":"This endpoint allows you to fetch permissions. The response will use pagination.
\n","urlObject":{"path":["api","admin","permissions"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e1b00bc4-2db2-4beb-b552-d31fe48c25f8"},{"name":"Give Roles To User","id":"bf22b476-b791-4d2c-a979-51a20a3e1bed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"user_id\": 1,\n\t\"role_ids\": [1,2,3,4]\n}"},"url":"https://api.calendesk.com/api/admin/roles/user/give","description":"This endpoint allows you to assign roles to user.
\n","urlObject":{"path":["api","admin","roles","user","give"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bf22b476-b791-4d2c-a979-51a20a3e1bed"},{"name":"Revoke Roles From User","id":"36e04d6e-aeef-49f4-a6d5-9748760d0f7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"user_id\": 1,\n\t\"role_ids\": [1,2,3,4]\n}"},"url":"https://api.calendesk.com/api/admin/roles/user/revoke","description":"This endpoint allows you to delete an assigment roles from user.
This endpoint allows you to delete an assigment roles from user.
This endpoint allows you to assign roles to user.
\n","urlObject":{"path":["api","admin","roles","permission","give"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b608f492-0729-40b4-9d5e-ac3493bebe1d"}],"id":"1f787910-97f0-42c2-a511-69356f6eb3fb","event":[{"listen":"prerequest","script":{"id":"1f60fc91-27bc-4fbc-9491-a346a2c67776","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6def7b3e-67a7-412d-867f-c5172ee86184","type":"text/javascript","exec":[""]}}],"_postman_id":"1f787910-97f0-42c2-a511-69356f6eb3fb","description":""},{"name":"Services","item":[{"name":"Service","id":"22687dd1-4cb5-46a4-a176-532a4f609fed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/services/{{serviceID}}","description":"This API endpoint allows you to fetch a service by its unique ID.
\nThe response will contain the following fields:
\n","urlObject":{"path":["api","admin","services","{{serviceID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"22687dd1-4cb5-46a4-a176-532a4f609fed"},{"name":"Services","id":"91944b16-32b9-439f-a704-952bea6c892f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/services","description":"This endpoint allows you to fetch all services.\n
\nWe do you need to know?
\n\n\n
statusWe use different statuses for booking:
\n\n
\n- \n
waiting- The booking is waiting for approvement.- \n
payment- The booking is waiting for payment.- \n
approved- The booking is approved and waiting to done.- \n
cancelled- The booking is cancelled.- \n
done- The booking is done.
\n\n\n
allow_dynamic_durationIt says if the service can use dynamic time for booking (
\nrequired_timeatPOST https://api.calendesk.com/api/user/bookings)
\n\n\n
payment_requiredIt will be used in the future. So far we don't support payments.
\n
\n\n\n
default_booking_statusThis says which status booking will receive if will be created for this service. Status
\nwaitingmeans that tenant's admin has to approve it.
\n\n","urlObject":{"path":["api","admin","services"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"91944b16-32b9-439f-a704-952bea6c892f"},{"name":"Search for Services","id":"84685c08-dd8a-4c9e-a5d7-2781b1fc8476","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/v2/services/search?status=active,inactive&query=test","description":"\n
typesSome services have types. It means you can't book just a service by its id, you need to choose which type you want to book as well.\nTypes have own price and duration.
\n
This endpoint allows you to fetch all services.\n
\nWe do you need to know?
\n\n\n
statusWe use different statuses for booking:
\n\n
\n- \n
waiting- The booking is waiting for approvement.- \n
payment- The booking is waiting for payment.- \n
approved- The booking is approved and waiting to done.- \n
cancelled- The booking is cancelled.- \n
done- The booking is done.
\n\n\n
allow_dynamic_durationIt says if the service can use dynamic time for booking (
\nrequired_timeatPOST https://api.calendesk.com/api/user/bookings)
\n\n\n
payment_requiredIt will be used in the future. So far we don't support payments.
\n
\n\n\n
default_booking_statusThis says which status booking will receive if will be created for this service. Status
\nwaitingmeans that tenant's admin has to approve it.
\n\n","urlObject":{"path":["api","admin","v2","services","search"],"host":["https://api.calendesk.com"],"query":[{"key":"status","value":"active,inactive"},{"key":"query","value":"test"}],"variable":[]}},"response":[],"_postman_id":"84685c08-dd8a-4c9e-a5d7-2781b1fc8476"},{"name":"Create Service","id":"9042a394-dcf2-4048-acd6-35b7da9a0fb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"category_id\" : 1,\n\t\"name\" : \"Strzyżenie profesjonalne\",\n\t\"description\" : \"To strzyżenie pozwoli Ci całkowicie oddać się w ręce profesjonalisty.\",\n\t\"duration\": 60,\n\t\"booking_time_before\" : 30,\n\t\"cancel_time_before\" : 30,\n \"max_booking_time\": 525600,\n\t\"price\": 1000,\n\t\"slots_every\" : 30,\n\t\"allow_dynamic_duration\" : true,\n\t\"status\" : \"active\",\n\t\"default_booking_status\" : \"approved\",\n\t\"resources\" : [],\n\t\"employees\" : [1],\n \"allow_online_payment\": false,\n \"payment_required\": false,\n\t\"types\" : [{\n\t\t\"name\" : \"Test\",\n\t\t\"duration\": 10,\n\t\t\"price\": 1000\n\t}],\n \"locations\" : [\n {\n \"type\": 1,\n \"data\": \"Warszawa, Jerozolimskie 1\"\n },\n {\n \"type\": 2,\n \"data\": \"+48500123456\"\n },\n {\n \"type\": 3\n }\n ],\n\t\"default_image_id\" : null\n\t\n}"},"url":"https://api.calendesk.com/api/admin/services","description":"\n
typesSome services have types. It means you can't book just a service by its id, you need to choose which type you want to book as well.\nTypes have own price and duration.
\n
This endpoint allows you to create a new service.
\n","urlObject":{"path":["api","admin","services"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9042a394-dcf2-4048-acd6-35b7da9a0fb0"},{"name":"Update Service","id":"52ec6706-f35c-48d1-b408-8ddcd6fe70d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"price\": 1400,\n \"order_position\": 1,\n \"default_image_id\": 11,\n \"max_booking_time\": 1440,\n \"employees\": [\n 1\n ],\n \"resources\": [],\n \"locations\": [\n {\n \"type\": 1,\n \"data\": \"Warszawa, Jerozolimskie 102 after update\"\n },\n {\n \"type\": 2,\n \"data\": \"+48500123456\"\n },\n {\n \"type\": 3\n }\n ]\n}"},"url":"https://api.calendesk.com/api/admin/services/24","description":"This endpoint allows you to update selected service. If you want to update types go to another endpoint https://api.calendesk.com/api/admin/services/{{serviceID}}/types/{{serviceTypeID}}
This endpoint allows you to add a picture to service.
\nThis request will remove the old picture and will set the new one as a default.
\nRemember about setting Conent-Type to application/x-www-form-urlencoded.
\nThe default limit is 10240 KB, the size will be limited to 600x600 px.
This endpoint allows you to delete a service.
This endpoint allows you to assign a new service type to any service.
\n","urlObject":{"path":["api","admin","services","{{serviceID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea5b7106-9df7-44f4-85fa-e87df9ec2832"},{"name":"Update Service's Type","id":"16553b96-929e-4278-af1a-9215e148e82d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\" : \"Test\",\n\t\"price\": 123,\n\t\"duration\" : 20\n}"},"url":"https://api.calendesk.com/api/admin/services/{{serviceID}}/types/{{serviceTypeID}}","description":"This endpoint allows you to update a service type.
\n","urlObject":{"path":["api","admin","services","{{serviceID}}","types","{{serviceTypeID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"16553b96-929e-4278-af1a-9215e148e82d"},{"name":"Delete Service's Type","id":"e07fd33f-2352-4dde-807a-547452edeecb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.calendesk.com/api/admin/services/{{serviceID}}/types/{{serviceTypeID}}","description":"This endpoint allows you to delete a service type.
\n","urlObject":{"path":["api","admin","services","{{serviceID}}","types","{{serviceTypeID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e07fd33f-2352-4dde-807a-547452edeecb"}],"id":"5ee7cb05-5d79-4daf-8f9b-7a530d949743","_postman_id":"5ee7cb05-5d79-4daf-8f9b-7a530d949743","description":""},{"name":"Locations","item":[{"name":"Locations","id":"2cfd8c0e-d795-4230-a794-e82b3dcca03f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/location","description":"This endpoint retrieves a list of locations. It supports filters for more targeted results.
\n","urlObject":{"path":["api","admin","location"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2cfd8c0e-d795-4230-a794-e82b3dcca03f"},{"name":"Create Location","id":"75256e83-8bd9-483e-bd1f-78587f1ea3ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": 4,\n \"data\": \"Inna nowa API\",\n \"service_ids\": [88,99,13]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/location","description":"This endpoint creates a new location with the specified details.
\nExample Body:
\n{\n \"type\": 4,\n \"data\": \"Location data\",\n \"service_ids\": [88, 99, 13]\n}\n\nThis endpoint updates an existing location identified by locationId.
Example Body:
\n{\n \"data\": \"Changed name\",\n \"service_ids\": [88, 99, 13]\n}\n\nThis endpoint deletes a location identified by locationId. It does not require a body.
Example Usage:
\nDELETE https://api.calendesk.com/api/admin/location/123\n\nThe Locations API provides a dynamic and versatile framework for managing location-related data, intricately linked with services in an administrative system. It is an essential part of the system's booking process, allowing users to select from various location types when scheduling appointments.
IN_PERSON (1): Physical locations with an address.PHONE (2): Telephone-based service locations.GOOGLE_MEET (3): Online locations via Google Meet.OTHER (4): Any other types of locations, defined as needed.ZOOM (5): Online locations via Zoom.TEAMS (6): Online locations via Microsoft Teams.SKYPE (7): Online locations via Skype.WHATSAPP (8): Service locations accessible through WhatsApp.IN_PERSON, PHONE, and OTHER, additional textual data can be provided for a better understanding of the location. This information is displayed to users, aiding them in making informed choices.This endpoint allows you to fetch statistics.
\n","urlObject":{"path":["api","admin","stats"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"afdf3b4e-93c0-4d27-87c6-de11f031b315"}],"id":"344fd89c-9f9d-4e28-8dc9-6b602f973161","_postman_id":"344fd89c-9f9d-4e28-8dc9-6b602f973161","description":""},{"name":"Subscriptions","item":[{"name":"Create Subscription","id":"e30cab23-dd0a-440f-acb8-9e642367234b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"stripe_product_price_id\": 1,\n \"name\": \"Monthly Booking x 10\",\n \"description\": \"Up to 10 bookings per month
\",\n \"recurring_interval\": \"month\",\n \"interval_count\": 1,\n \"service_limit\": 10,\n \"service_ids\": [1, 5, 12],\n \"wants_invoice\": true,\n \"tax\": \"23\",\n \"status\": \"active\",\n \"allow_users_to_cancel\": true,\n \"max_active_subscriptions\": 1,\n \"gdpr_fields\": \"[{\\\"name\\\":\\\"GDPR\\\",\\\"label\\\":\\\"I accept the Terms and Privacy Policy\\\",\\\"required\\\":true},{\\\"name\\\":\\\"Optional consent\\\",\\\"label\\\":\\\"Marketing consent
\\\",\\\"required\\\":false}]\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/subscriptions","description":"POST\nhttps://api.calendesk.com/api/admin/subscriptions
Creates a new subscription plan that can be offered to clients. Supports recurring billing via Stripe, service limits, GDPR consent fields, invoicing options, and automatic payment stop rules.
\nRequires ADD_SUBSCRIPTIONS permission.
The request body should be in JSON format.
\nThe gdpr_fields value must be a JSON-encoded string containing an array of consent field objects:
{\n \"stripe_product_price_id\": 1,\n \"name\": \"Monthly Booking x 10\",\n \"description\": \"<p>Up to 10 bookings per month</p>\",\n \"recurring_interval\": \"month\",\n \"interval_count\": 1,\n \"service_limit\": 10,\n \"service_ids\": [1, 5, 12],\n \"wants_invoice\": true,\n \"tax\": \"23\",\n \"status\": \"active\",\n \"allow_users_to_cancel\": true,\n \"max_active_subscriptions\": 1,\n \"gdpr_fields\": \"[{\\\"name\\\":\\\"GDPR\\\",\\\"label\\\":\\\"I accept the Terms and Privacy Policy\\\",\\\"required\\\":true},{\\\"name\\\":\\\"Optional consent\\\",\\\"label\\\":\\\"<p>Marketing consent</p>\\\",\\\"required\\\":false}]\"\n}\n201 Created
\n{\n \"id\": 1,\n \"stripe_product_price_id\": 1,\n \"name\": \"Monthly Booking x 10\",\n \"description\": \"<p>Up to 10 bookings per month</p>\",\n \"status\": \"active\",\n \"success_url\": null,\n \"cancel_url\": null,\n \"recurring_interval\": \"month\",\n \"interval_count\": 1,\n \"service_limit\": 10,\n \"wants_invoice\": true,\n \"require_billing_data\": false,\n \"disable_robot_indexing\": false,\n \"only_company_invoice_data_type\": false,\n \"allow_users_to_cancel\": true,\n \"stop_automatic_payments_recurring_interval\": null,\n \"stop_automatic_payments_interval_count\": null,\n \"gdpr_fields\": \"[{\\\"name\\\":\\\"GDPR\\\",\\\"label\\\":\\\"I accept the Terms and Privacy Policy\\\",\\\"required\\\":true}]\",\n \"tax\": \"23\",\n \"max_active_subscriptions\": 1,\n \"active_subscriptions_count\": 0,\n \"created_at\": \"2026-02-19T12:00:00+00:00\",\n \"updated_at\": \"2026-02-19T12:00:00+00:00\",\n \"price\": {},\n \"services\": []\n}\n422 Unprocessable Entity - Validation errors
\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"name\": [\"The name field is required.\"],\n \"status\": [\"The status field is required.\"]\n }\n}\nUp to 20 bookings per month
\",\n \"recurring_interval\": \"month\",\n \"interval_count\": 1,\n \"service_limit\": 20,\n \"service_ids\": [1, 5],\n \"wants_invoice\": true,\n \"tax\": \"23\",\n \"allow_users_to_cancel\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/subscriptions/{{subscriptionId}}","description":"PUT\nhttps://api.calendesk.com/api/admin/subscriptions/{subscriptionId}
Updates an existing subscription. Service associations are fully replaced when service_ids is provided. Note that stripe_product_price_id, stop_automatic_payments_recurring_interval, and stop_automatic_payments_interval_count cannot be changed after creation.
Requires EDIT_SUBSCRIPTIONS permission.
The request body should be in JSON format.
\n{\n \"name\": \"Monthly Booking x 20\",\n \"status\": \"active\",\n \"description\": \"<p>Up to 20 bookings per month</p>\",\n \"recurring_interval\": \"month\",\n \"interval_count\": 1,\n \"service_limit\": 20,\n \"service_ids\": [1, 5],\n \"wants_invoice\": true,\n \"tax\": \"23\",\n \"allow_users_to_cancel\": true\n}\n200 OK
\n{\n \"id\": 1,\n \"stripe_product_price_id\": 1,\n \"name\": \"Monthly Booking x 20\",\n \"description\": \"<p>Up to 20 bookings per month</p>\",\n \"status\": \"active\",\n \"success_url\": null,\n \"cancel_url\": null,\n \"recurring_interval\": \"month\",\n \"interval_count\": 1,\n \"service_limit\": 20,\n \"wants_invoice\": true,\n \"require_billing_data\": false,\n \"disable_robot_indexing\": false,\n \"only_company_invoice_data_type\": false,\n \"allow_users_to_cancel\": true,\n \"stop_automatic_payments_recurring_interval\": null,\n \"stop_automatic_payments_interval_count\": null,\n \"gdpr_fields\": null,\n \"tax\": \"23\",\n \"max_active_subscriptions\": null,\n \"active_subscriptions_count\": 5,\n \"created_at\": \"2026-02-19T12:00:00+00:00\",\n \"updated_at\": \"2026-02-19T14:30:00+00:00\",\n \"price\": {},\n \"services\": []\n}\n404 Not Found
\n{\n \"message\": \"Not found.\"\n}\n422 Unprocessable Entity - Validation errors
\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"name\": [\"The name field is required.\"],\n \"status\": [\"The status field is required.\"]\n }\n}\nDELETE\nhttps://api.calendesk.com/api/admin/subscriptions/{subscriptionId}
Deletes a subscription. The subscription can only be deleted if no users have subscribed to it. If any user subscriptions exist, the request will be rejected.
\nRequires DELETE_SUBSCRIPTIONS permission.
200 OK - Empty response
\n403 Forbidden - Subscription has active user subscriptions
\n{\n \"message\": \"Forbidden.\"\n}\n404 Not Found
\n{\n \"message\": \"Not found.\"\n}\nGEThttps://api.calendesk.com/api/admin/subscriptions/{subscriptionId}
Retrieves a single subscription by its ID, including the count of currently active user subscriptions (active or canceled but not yet expired).
\nRequires SHOW_SUBSCRIPTIONS permission.
200 OK
\n{\n \"id\": 1,\n \"stripe_product_price_id\": 1,\n \"name\": \"Monthly Booking x 10\",\n \"description\": \"<p class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Up to 10 bookings per month</p>\",\n \"status\": \"active\",\n \"success_url\": null,\n \"cancel_url\": null,\n \"recurring_interval\": \"month\",\n \"interval_count\": 1,\n \"service_limit\": 10,\n \"wants_invoice\": true,\n \"require_billing_data\": false,\n \"disable_robot_indexing\": false,\n \"only_company_invoice_data_type\": false,\n \"allow_users_to_cancel\": true,\n \"stop_automatic_payments_recurring_interval\": null,\n \"stop_automatic_payments_interval_count\": null,\n \"gdpr_fields\": \"[{\\\"name\\\":\\\"GDPR\\\",\\\"label\\\":\\\"I accept the Terms and Privacy Policy\\\",\\\"required\\\":true}]\",\n \"tax\": \"23\",\n \"max_active_subscriptions\": 1,\n \"active_subscriptions_count\": 5,\n \"created_at\": \"2026-02-19T12:00:00+00:00\",\n \"updated_at\": \"2026-02-19T12:00:00+00:00\",\n \"price\": {},\n \"services\": []\n}\n\n404 Not Found
\n{\n \"message\": \"No query results for model [Subscription].\"\n}\n\nGET\nhttps://api.calendesk.com/api/admin/subscriptions
Retrieves a paginated list of subscriptions with optional filtering by search query, status, and associated services. Results include active subscription counts, Stripe price details, and linked services.
\nRequires SHOW_SUBSCRIPTIONS permission.
GET /api/admin/subscriptions?query=booking&status_ids=active&limit=10&page=1&order_by=created_at&ascending=false\n200 OK
\n{\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"stripe_product_price_id\": 1,\n \"name\": \"Monthly Booking x 10\",\n \"description\": \"<p>Up to 10 bookings per month</p>\",\n \"status\": \"active\",\n \"success_url\": null,\n \"cancel_url\": null,\n \"recurring_interval\": \"month\",\n \"interval_count\": 1,\n \"service_limit\": 10,\n \"wants_invoice\": true,\n \"require_billing_data\": false,\n \"disable_robot_indexing\": false,\n \"only_company_invoice_data_type\": false,\n \"allow_users_to_cancel\": true,\n \"stop_automatic_payments_recurring_interval\": null,\n \"stop_automatic_payments_interval_count\": null,\n \"gdpr_fields\": null,\n \"tax\": \"23\",\n \"max_active_subscriptions\": 1,\n \"active_subscriptions_count\": 5,\n \"created_at\": \"2026-02-19T12:00:00+00:00\",\n \"updated_at\": \"2026-02-19T12:00:00+00:00\",\n \"price\": {},\n \"services\": []\n }\n ],\n \"first_page_url\": \"https://api.calendesk.com/api/admin/subscriptions?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"https://api.calendesk.com/api/admin/subscriptions?page=1\",\n \"links\": [],\n \"next_page_url\": null,\n \"path\": \"https://api.calendesk.com/api/admin/subscriptions\",\n \"per_page\": 50,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n}\nGET\nhttps://api.calendesk.com/api/admin/subscriptions/search
Lightweight search endpoint that returns a simplified list of subscriptions. Useful for autocomplete and dropdown selectors. Returns only core fields (ID, name, status, price ID) without pagination metadata.
\nRequires SEARCH_SUBSCRIPTIONS permission.
GET /api/admin/subscriptions/search?query=booking&status=active&limit=10&order_by=name&ascending=true\n200 OK
\nReturns a flat array (no pagination wrapper).
\n[\n {\n \"id\": 1,\n \"stripe_product_price_id\": 1,\n \"name\": \"Monthly Booking x 10\",\n \"status\": \"active\"\n },\n {\n \"id\": 2,\n \"stripe_product_price_id\": 3,\n \"name\": \"Monthly Booking x 20\",\n \"status\": \"active\"\n }\n]\nPOST\nhttps://api.calendesk.com/api/admin/stripe/connect/subscriptions/{subscriptionId}/prices/change
Changes the price of a subscription. The new price takes effect immediately for new customers, while existing subscriptions remain unaffected unless prorations are explicitly specified via proration_behavior. Supports two modes: setting a new price directly via unit_amount, or migrating to an existing Stripe price via from_stripe_product_price_id. The change is processed asynchronously.
Requires EDIT_SERVICES permission. Stripe Connect account must be active and ready to process payments.
The request body should be in JSON format. Two mutually exclusive modes are available:
\nMode 1: New price — provide unit_amount and proration_behavior.
Mode 2: Existing price — provide from_stripe_product_price_id (prohibits unit_amount, recurring, interval_count).
Mode 1: Set a new price
\n{\n \"unit_amount\": 30000,\n \"proration_behavior\": \"none\"\n}\nMode 1: Set a new price with changed billing interval
\n{\n \"unit_amount\": 50000,\n \"proration_behavior\": \"create_prorations\",\n \"recurring\": \"year\",\n \"interval_count\": 1\n}\nMode 2: Migrate to an existing Stripe price
\n{\n \"from_stripe_product_price_id\": \"price_1abc2def3ghi\"\n}\n200 OK - Empty response. The price change is processed asynchronously.
\n403 Forbidden - Stripe payments are not configured or account is not ready
\n{\n \"message\": \"Stripe payments are disabled or not fully configured.\"\n}\n404 Not Found
\n{\n \"message\": \"Not found.\"\n}\n422 Unprocessable Entity - Validation errors
\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"unit_amount\": [\"The unit amount field is required when from stripe product price id is not present.\"]\n }\n}\nThis endpoint allows you to fetch a tag by its id.
This endpoint allows you to fetch tags. The response will use pagination.
\n","urlObject":{"path":["api","admin","tags"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b69c6fd5-70cd-4207-986e-c29be802969c"},{"name":"Create Tag","id":"45e3f505-58e0-449f-a314-25faddfda997","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\" : \"Custom tag\"\n}"},"url":"https://api.calendesk.com/api/admin/tags","description":"This endpoint allows you to create a new tag.
\n","urlObject":{"path":["api","admin","tags"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"45e3f505-58e0-449f-a314-25faddfda997"},{"name":"Update Tag","id":"2a2d9046-9227-4405-ac6c-a80fd806b269","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\" : \"Updated tag value\"\n}"},"url":"https://api.calendesk.com/api/admin/tags/{{tagID}}","description":"This endpoint allows you to update a tag.
\n","urlObject":{"path":["api","admin","tags","{{tagID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2a2d9046-9227-4405-ac6c-a80fd806b269"},{"name":"Delete Tag","id":"10dda001-4607-430f-b4f0-7a0bc6eb2278","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.calendesk.com/api/admin/tags/{{tagID}}","description":"This endpoint allows you to delete a tag.
This endpoint allows you to fetch all user images. This is private storage for users, they can upload images there and use them later. The response will use pagination.
\n","urlObject":{"path":["api","admin","user-images"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"18b5241b-1475-46df-98cf-46c43af8718e"},{"name":"Upload User Image","id":"2e348f2a-e34a-4d42-a6ff-dd37a605745e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","src":"/home/notebook/Desktop/Projects/mojprogramista/shared/postman/bg1.jpg"},{"key":"name","type":"text","value":"bg_1"},{"key":"description","value":"My background","type":"text"}]},"url":"https://api.calendesk.com/api/admin/user-images","description":"This endpoint allows you to add a picture to users images.
\nRemember about setting Conent-Type to application/x-www-form-urlencoded.
\nThe upload size limit is 10240 KB, the width size will be limited to 2000 px.
This endpoint allows you to add a picture to users images.
\nRemember about setting Conent-Type to application/x-www-form-urlencoded.
\nThe upload size limit is 10240 KB, the width size will be limited to 2000 px.
This endpoint allows you to delete a user image.
This endpoint allows you to fetch unavailable booking slots. The response is paginated, and you can filter results using the provided parameters.
\nGET https://api.calendesk.com/api/admin/unavailable-booking-slots
GET https://api.calendesk.com/api/admin/unavailable-booking-slots?employee_ids=4,5&from=2022-05-01&to=2022-05-31&group_id=abc123
\n","urlObject":{"path":["api","admin","unavailable-booking-slots"],"host":["https://api.calendesk.com"],"query":[{"key":"from","value":"{{from}}"},{"key":"to","value":"{{to}}"}],"variable":[]}},"response":[],"_postman_id":"8b908990-4ad4-4fd4-afcd-df7d44e67a39"},{"name":"Create Unavailable Booking Slots","id":"7755f139-f0df-424d-b006-705fd53a4162","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"employee_id\" : 1,\n\t\"start_date\" : \"2020-03-01\",\n\t\"end_date\" : \"2020-03-01\",\n\t\"description\" : \"Day off\"\n}"},"url":"https://api.calendesk.com/api/admin/unavailable-booking-slots","description":"This endpoint allows you to create an unavailable booking spot (block the spot).
\nYou can block the spot for all employees or just for one. You can add a description to tell the others why you're blocking the spot e.g. holidays.
\nYou can block specific hours or all day. This is just information for employees that there is a blocked spot, but it doesn't block the calendar from putting other events.
This endpoint allows you to update an unavailable booking spot (block the spot).
\nYou can block the spot for all employees or just for one. You can add a description to tell the others why you're blocking the spot e.g. holidays.
\nYou can block specific hours or all day. This is just information for employees that there is a blocked spot, but it doesn't block the calendar from putting other events.
This endpoint allows you to delete a unavailable booking slot.
This endpoint allows you to fetch logged user's data.
\n","urlObject":{"path":["api","admin","user"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"47413f12-8868-46bd-ba4d-cb648d8d57be"},{"name":"User","id":"a6787bb2-312f-415a-bd57-d23a137299fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/users/{{userID}}","description":"This endpoint allows you to fetch a user by its id.
This endpoint allows you to fetch users. The response will use pagination.
\n","urlObject":{"path":["api","admin","v2","users"],"host":["https://api.calendesk.com"],"query":[{"key":"query","value":"MPR"}],"variable":[]}},"response":[],"_postman_id":"648d616b-887a-4c2c-9135-d5808df625b3"},{"name":"Search for Users","id":"0b294cdd-962d-4fc1-b42c-f644f35168ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/v2/users/search?query=adam&order_by=id&ascending=0","description":"This endpoint allows you to fetch users. The response will use pagination.
\n","urlObject":{"path":["api","admin","v2","users","search"],"host":["https://api.calendesk.com"],"query":[{"key":"query","value":"adam"},{"key":"order_by","value":"id"},{"key":"ascending","value":"0"}],"variable":[]}},"response":[],"_postman_id":"0b294cdd-962d-4fc1-b42c-f644f35168ee"},{"name":"Users V1","id":"1453bf76-9aee-4a8d-bdf5-bc9b5edb02a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/users?order_by=id&ascending=0","description":"This endpoint allows you to fetch users. The response will use pagination.
\n","urlObject":{"path":["api","admin","users"],"host":["https://api.calendesk.com"],"query":[{"key":"order_by","value":"id"},{"key":"ascending","value":"0"}],"variable":[]}},"response":[],"_postman_id":"1453bf76-9aee-4a8d-bdf5-bc9b5edb02a4"},{"name":"Create User","id":"505af307-573a-4dc4-8d9e-3ce04166ab79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\" : \"Test\",\n\t\"surname\" : \"User\",\n\t\"email\" : \"test@calendesk.com\",\n\t\"password\" : \"12345678\",\n\t\"activate_account\" : 1,\n\t\"default_phone\": \"+48500123456\",\n\t\"date_of_birth\": \"2019-12-04\",\n\t\"groups\" : [1],\n\t\"gender\": \"female\",\n\t\"description\" : \"test\",\n\t\"default_address\" : {\n \"city\" : \"Warsaw\",\n\t\t\"street\" : \"Test\",\n\t\t\"house_number\": \"12\"\n\t},\n\t\"default_image_id\" : 14\n}"},"url":"https://api.calendesk.com/api/admin/users","description":"This endpoint allows you to create a new user, which will be able to login to the user's panel (website for tenant's clients) and mobile app (mobile app for tenant's clients).
The same user can also receive permission to the admin's panel (admin panel for tenant's). See POST api/admin/permissions in Calendesk API (admin's endpoints).
This endpoint allows you to update a user's data.
\n","urlObject":{"path":["api","admin","users","{{userID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2c1924f-b308-4d3a-8bf3-7ee98b0e3e61"},{"name":"Delete User","id":"fd0ff3c5-27b3-44d2-9e4d-85c4d6825585","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.calendesk.com/api/admin/users/{{userID}}","description":"This endpoint allows you to delete a user.
This endpoint allows you to add a picture to user's account.
\nThis request will remove the old avatar and will set the new one.
\nRemember about setting Conent-Type to application/x-www-form-urlencoded.
\nThe default limit is 10240 KB, the size will be limited to 600x600 px.
This endpoint allows you to generate file with selected users.
\n","urlObject":{"path":["api","admin","users","generate","{{type}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d68bc38e-587a-40bf-ba9c-9a94624b6a4f"},{"name":"Update User's Description","id":"b72ac91c-47ed-41b3-aef7-4fd8d83bd962","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\": \"New description\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/users/{{userId}}/description","urlObject":{"path":["api","admin","users","{{userId}}","description"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b72ac91c-47ed-41b3-aef7-4fd8d83bd962"}],"id":"608c23d7-325c-4221-b55f-33cca1abb022","event":[{"listen":"prerequest","script":{"id":"00b03f60-50e0-44cd-a193-7ffe9f457f18","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"62492887-b931-45a8-9251-b905109104bb","type":"text/javascript","exec":[""]}}],"_postman_id":"608c23d7-325c-4221-b55f-33cca1abb022","description":""},{"name":"User Subscription","item":[{"name":"Get User Subscriptions","id":"39b46dac-29e7-4f2e-86f5-b1e85c8c2a6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/v2/users/subscriptions","urlObject":{"path":["api","admin","v2","users","subscriptions"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"39b46dac-29e7-4f2e-86f5-b1e85c8c2a6f"},{"name":"Create User Subscription","id":"640945f2-4edb-44a7-9a03-9f7003a11abd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_id\": 1,\n \"subscription_id\": 22,\n \"create_payment\": true,\n \"payment_method\": \"transfer\",\n \"transaction_id\": \"Transfer from 20.08.2022\",\n \"amount\": 100000\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/users/subscriptions","description":"This API endpoint allows you to create a subscription for a user. You can specify the subscription details, including the user ID, subscription ID, payment details, and more. This is particularly useful for managing subscriptions and payments within your system.
\nEndpoint: POST https://api.calendesk.com/api/admin/users/subscriptions
The request body should be a JSON object with the following keys and values:
\n{\n \"user_id\": 1,\n \"subscription_id\": 22,\n \"create_payment\": true,\n \"payment_method\": \"transfer\",\n \"transaction_id\": \"Transfer from 20.08.2022\",\n \"amount\": 100000\n}\n\nWhen creating a user subscription, you can specify whether to create a payment record (create_payment) and define the payment method used. The payment_method can be one of the following: stripe, cash, transfer, or card. Each payment method requires the amount to be specified in the smallest unit of the currency (e.g., cents for USD). If the payment method involves a transaction that can be uniquely identified (e.g., bank transfer), you should include a transaction_id.
This endpoint is critical for managing user subscriptions and ensuring that payments are tracked and processed according to the specified method. By setting the create_payment flag to true, you instruct the system to create a corresponding payment record for bookkeeping purposes.
This API endpoint is designed for recording a payment transaction against a specific user subscription. By utilizing this endpoint, you can add a payment transaction to a user's subscription, specifying the method of payment, a unique transaction ID, and the payment amount. This feature is essential for maintaining accurate and up-to-date financial records within your platform.
\nEndpoint: POST https://api.calendesk.com/api/admin/users/subscriptions/{{userSubscriptionID}}/transactions
The request body requires a JSON object that includes details about the payment transaction. Below are the keys you need to provide, along with their descriptions and examples:
\n{\n \"payment_method\": \"cash\",\n \"transaction_id\": \"Cash 20.08.2022\",\n \"amount\": 10000\n}\n\nThis endpoint allows for the detailed recording of financial transactions related to user subscriptions. By specifying a payment_method, you can accurately track how payments are made, whether through direct transfers, cash payments, or card transactions. The transaction_id provides a unique reference to each transaction, facilitating easier auditing and financial management. Lastly, the amount should be input in the smallest denomination of your currency (such as cents for USD) to maintain precision in financial records.
By leveraging this API, administrators can ensure that all subscription-related payments are meticulously recorded and easily retrievable for future reference, audits, or financial analysis.
\n","urlObject":{"path":["api","admin","users","subscriptions","{{userSubscriptionID}}","transactions"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"de0a3bad-f6d5-4c04-b058-266a8a913dc4"},{"name":"Delete User Subscription Payment Transaction","id":"43cb4266-e167-4027-ba3b-51a70306bf9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/users/subscriptions/185/transactions/65","urlObject":{"path":["api","admin","users","subscriptions","185","transactions","65"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"43cb4266-e167-4027-ba3b-51a70306bf9b"}],"id":"dbd561e0-07fb-49b2-aeb7-7129259557f7","_postman_id":"dbd561e0-07fb-49b2-aeb7-7129259557f7","description":""},{"name":"Webhooks","item":[{"name":"Create Webhook Subscription","id":"9484be30-7eec-4ee7-ad3a-f519cd2ef017","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\" : \"https://test-website.com/handle-webhook/\",\n \"events\": [\n \"booking_created\",\n \"booking_updated\",\n \"booking_deleted\",\n \"booking_paid\",\n \"user_created\",\n \"user_deleted\",\n \"user_updated\",\n \"user_subscription_created\",\n \"user_subscription_deleted\",\n \"user_subscription_canceled\",\n \"user_subscription_payment_transaction_created\",\n \"newsletter_email_created\",\n \"newsletter_email_deleted\",\n \"newsletter_email_verified\",\n \"simple_store_product_payment_transaction_created\",\n \"availability_schedule_created\",\n \"availability_schedule_deleted\",\n \"availability_schedule_updated\"\n ],\n \"signing_key\": \"secretKeyToVerify\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/admin/webhooks","description":"This API endpoint allows you to create a webhook for various events.
\nEndpoint: POST /api/admin/webhooks
curl -X POST http://api.calendesk.local/api/admin/webhooks \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"url\": \"https://calendesk.com/handle-webhook/\",\n \"events\": [\n \"booking_created\",\n \"booking_updated\",\n \"booking_deleted\",\n \"booking_paid\",\n \"user_created\",\n \"user_deleted\",\n \"user_updated\",\n \"user_subscription_created\",\n \"user_subscription_deleted\",\n \"user_subscription_canceled\",\n \"user_subscription_payment_transaction_created\",\n \"newsletter_email_created\",\n \"newsletter_email_deleted\",\n \"newsletter_email_verified\",\n \"simple_store_product_payment_transaction_created\"\n ],\n \"signing_key\": \"111111\"\n}'\n\nbooking_createdThis event will be triggered when a new booking is created.
\nbooking_updatedThis event will be triggered if any of the following data is changed:
\na) Booking data from the following keys:
\nstart_date
end_date
start_time
end_time
service_id
service_type_id
service_location_id
recurrence_params
simple_store_product_ids - user or admin added/removed any products attached to a booking
status - status has changed to any of the following: waiting, payment, approved. Note: Status done is a mute status and won't trigger any updates. Also, status cancelled will fire a different webhook: booking_deleted.
employee_id
service_location_id
booking_deletedThis event will be triggered when a booking has been cancelled or removed. You can distinguish if it was cancelled (status = cancelled) or removed (any other status that is not equal to cancelled).
booking_paidThis event will be triggered when a booking has been paid.
\nuser_createdThis event will be triggered when a new user is created.
\nuser_deletedThis event will be triggered when a user is deleted.
\nuser_updatedThis event will be triggered when a user is updated.
\nuser_subscription_createdThis event will be triggered when a new user subscription is created.
\nuser_subscription_deletedThis event will be triggered when a user subscription is deleted.
\nuser_subscription_canceledThis event will be triggered when a user subscription is canceled.
\nuser_subscription_payment_transaction_createdThis event will be triggered when a new user subscription payment transaction is created.
\nnewsletter_email_createdThis event will be triggered when a new newsletter email is created.
\nnewsletter_email_deletedThis event will be triggered when a newsletter email is deleted.
\nnewsletter_email_verifiedThis event will be triggered when a newsletter email is verified.
\nsimple_store_product_payment_transaction_createdThis event will be triggered when a new simple store product payment transaction is created.
\navailability_schedule_createdThis event will be triggered when a new availability schedule is created.
\navailability_schedule_updatedThis event will be triggered when an availability schedule is updated.
\navailability_schedule_deletedThis event will be triggered when an availability schedule is deleted.
\nOn success, the server responds with a 201 Created status and the details of the created webhook.
This API endpoint allows you to create a webhook for various events.
\nEndpoint: PUT /api/admin/webhooks/{{webhookId}}
curl -X PUT http://api.calendesk.local/api/admin/webhooks/5 \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"url\": \"https://test-website.com/handle-webhook/\",\n \"events\": [\n \"booking_created\",\n \"booking_updated\",\n \"booking_deleted\",\n \"booking_paid\",\n \"user_created\",\n \"user_deleted\",\n \"user_updated\",\n \"user_subscription_created\",\n \"user_subscription_deleted\",\n \"user_subscription_canceled\",\n \"user_subscription_payment_transaction_created\",\n \"newsletter_email_created\",\n \"newsletter_email_deleted\",\n \"newsletter_email_verified\",\n \"simple_store_product_payment_transaction_created\"\n ],\n \"signing_key\": \"secretKey\"\n}'\n\nbooking_createdThis event will be triggered when a new booking is created.
\nbooking_updatedThis event will be triggered if any of the following data is changed:
\na) Booking data from the following keys:
\nstart_date
end_date
start_time
end_time
service_id
service_type_id
service_location_id
recurrence_params
simple_store_product_ids - user or admin added/removed any products attached to a booking
status - status has changed to any of the following: waiting, payment, approved. Note: Status done is a mute status and won't trigger any updates. Also, status cancelled will fire a different webhook: booking_deleted.
employee_id
service_location_id
booking_deletedThis event will be triggered when a booking has been cancelled or removed. You can distinguish if it was cancelled (status = cancelled) or removed (any other status that is not equal to cancelled).
booking_paidThis event will be triggered when a booking has been paid.
\nuser_createdThis event will be triggered when a new user is created.
\nuser_deletedThis event will be triggered when a user is deleted.
\nuser_updatedThis event will be triggered when a user is updated.
\nuser_subscription_createdThis event will be triggered when a new user subscription is created.
\nuser_subscription_deletedThis event will be triggered when a user subscription is deleted.
\nuser_subscription_canceledThis event will be triggered when a user subscription is canceled.
\nuser_subscription_payment_transaction_createdThis event will be triggered when a new user subscription payment transaction is created.
\nnewsletter_email_createdThis event will be triggered when a new newsletter email is created.
\nnewsletter_email_deletedThis event will be triggered when a newsletter email is deleted.
\nnewsletter_email_verifiedThis event will be triggered when a newsletter email is verified.
\nsimple_store_product_payment_transaction_createdThis event will be triggered when a new simple store product payment transaction is created.
\navailability_schedule_createdThis event will be triggered when a new availability schedule is created.
\navailability_schedule_updatedThis event will be triggered when an availability schedule is updated.
\navailability_schedule_deletedThis event will be triggered when an availability schedule is deleted.
\nOn success, the server responds with a 200 OK status and the details of the created webhook.
This API endpoint allows you to retrieve all the webhooks created in the system.
\nEndpoint: GET /api/admin/webhooks
The response contains a list of webhooks. The response can be paginated.
\n{\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 17,\n \"url\": \"https://calendesk.com/example\",\n \"user_id\": 1,\n \"events\": [\n \"booking_created\",\n \"booking_updated\",\n \"booking_deleted\",\n \"booking_paid\"\n ],\n \"created_at\": \"2024-05-27T13:04:14+00:00\"\n }\n ],\n \"first_page_url\": \"http://api.calendesk.com/api/admin/webhooks?page=1&limit=50\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"http://api.calendesk.com/api/admin/webhooks?page=1&limit=50\",\n \"next_page_url\": null,\n \"path\": \"http://api.calendesk.com/api/admin/webhooks\",\n \"per_page\": 50,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n}\n\nEach object in the data array represents a webhook and contains the following fields:
This API endpoint allows you to retrieve details of a single webhook.
\nEndpoint: GET /api/admin/webhooks/{id}
The response contains details of the specified webhook.
\n{\n \"id\": 17,\n \"url\": \"https://calendesk.com/example\",\n \"user_id\": 1,\n \"events\": [\n \"booking_created\",\n \"booking_updated\",\n \"booking_deleted\",\n \"booking_paid\"\n ],\n \"created_at\": \"2024-05-27T13:04:14+00:00\"\n}\n\nThe object represents a webhook and contains the following fields:
\n","urlObject":{"path":["api","admin","webhooks","7"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba709605-6d3f-4997-9c72-d93d395cfda2"},{"name":"Delete Webhook Subscription","id":"4e918278-9910-4dd7-9dd0-78a0dd063606","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/admin/webhooks/{{webhookId}}","description":"This API endpoint allows you to delete a specific webhook.
\nEndpoint: DELETE /api/admin/webhooks/{id}
On success, the server responds with a 200 OK status, indicating that the webhook has been successfully deleted.
The Calendesk Webhooks API allows you to listen to various events that occur
within the Calendesk system. By configuring webhooks, you can receive real-time
notifications about specific events, such as booking updates, user actions,
subscription changes, newsletter emails, and more. This API provides a flexible
and efficient way to integrate your application with Calendesk and stay updated
with the latest information.
Each webhook request includes the following HTTP headers:
\nIf your endpoint fails to respond with a 2xx status code, Calendesk will
automatically retry the delivery up to 8 times with exponential backoff:
Timeouts: Each delivery attempt has a 5-second connection timeout and
5-second response timeout. Ensure your endpoint responds quickly.
Best practices:
\nReturn a 2xx status code immediately upon receiving the webhook
\nProcess the payload asynchronously if needed
\nUse X-Calendesk-Delivery-Id to handle duplicate deliveries
A webhook object is used to configure and manage webhooks. It contains the
following properties:
url (required): The URL where the webhook events will be sent. This URL
should be able to receive HTTP POST requests.
events (required): An array of event types that you want to listen to.
Each event type is represented by a string. The supported event types are:
Booking events:
\nbooking_created: Triggered when a new booking is created.
booking_updated: Triggered when an existing booking is updated.
booking_deleted: Triggered when a booking is deleted.
booking_paid: Triggered when a booking is paid.
User events:
\nuser_created: Triggered when a new user is created.
user_updated: Triggered when an existing user is updated.
user_deleted: Triggered when a user is deleted.
Subscription events:
\nuser_subscription_created: Triggered when a user subscription is created.
user_subscription_deleted: Triggered when a user subscription is deleted.
user_subscription_canceled: Triggered when a user subscription is canceled.
user_subscription_payment_transaction_created: Triggered when a payment
transaction is created for a user subscription.
Newsletter events:
\nnewsletter_email_created: Triggered when a newsletter email is created.
newsletter_email_deleted: Triggered when a newsletter email is deleted.
newsletter_email_verified: Triggered when a newsletter email is verified.
Simple Store events:
\nsimple_store_product_payment_transaction_created: Triggered when a paymentAvailability schedule events:
\navailability_schedule_created: Triggered when a new availability schedule
is created.
availability_schedule_updated: Triggered when an availability schedule
is updated.
availability_schedule_deleted: Triggered when an availability schedule
is deleted.
signing_key (optional): A secret key used to verify webhook authenticity.
If provided, Calendesk will include it in the Calendesk-Signing-Key header.
Each webhook POST request contains a JSON body with:
\n{\n \"created_at\": \"2025-01-15T10:30:00Z\",\n \"event\": \"booking_created\",\n \"payload\": {\n // Event-specific data\n }\n}\n\nGET https://api.calendesk.com/api/admin/files
This endpoint allows you to get all files.
\nPOST https://api.calendesk.com/api/admin/files/upload
This endpoint allows you to upload a file to the system.
\n```http
POST https://api.calendesk.com/api/admin/files/upload
Content-Type: multipart/form-data
{
\"file\": (binary file data),
\"user_id\": 1
}
GET https://api.calendesk.com/api/admin/files/download/{fileId}
This endpoint allows you to download a specific file.
\nDELETE https://api.calendesk.com/api/admin/files/{fileId}
This endpoint allows you to delete a specific file.
\nPATCH https://api.calendesk.com/api/admin/files/download/{fileId}
This endpoint allows you to update a specific file.
\nGET https://api.calendesk.com/api/admin/directories
This endpoint allows you to get all file directories.
\nPOST https://api.calendesk.com/api/admin/directories
This endpoint allows you to create a directory for your files.
\n```json
{
\"name\": \"New Directory\",
\"parent_directory_id\": 5,
\"user_id\": 1
}
PATCH https://api.calendesk.com/api/admin/directories/{directoryId}
This endpoint allows you to update an existing directory.
\n```json
{
\"name\": \"Updated Directory Name\",
\"parent_directory_id\": 3,
\"user_id\": 1
}
DELETE https://api.calendesk.com/api/admin/directories/{directoryId}
This endpoint allows you to update an existing directory.
\nThis endpoint allows you to fetch available booking slots sorted by employees IDs.
\n","urlObject":{"path":["api","available-slots"],"host":["https://api.calendesk.com"],"query":[{"key":"service_id","value":"119"},{"key":"number_of_days","value":"2"},{"key":"start_date","value":"2024-06-03"},{"key":"used_slots","value":"1"},{"key":"employee_ids","value":"4"},{"key":"customer_time_zone","value":"Europe/Madrid"},{"key":"booked_slots","value":"1"},{"key":"location_id","value":"3"}],"variable":[]}},"response":[],"_postman_id":"ec301c78-b052-4d9f-940b-bbeb75db32ec"},{"name":"Create Booking","id":"ec772900-e830-412b-a2be-537cef3a6735","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"employee_id\": 1,\n \"service_id\": 1,\n \"start_date\": \"2025-06-09\",\n \"start_time\": \"07:00\",\n \"customer_time_zone\": \"Europe/Warsaw\",\n \"custom_fields\": \"[{\\\"type\\\":1,\\\"label\\\":\\\"Please type here...\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"Additional Information\\\"},{\\\"type\\\":6,\\\"label\\\":null,\\\"description\\\":\\\"Address
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"123 Main Street, Apt 4B, New York, NY 10001, USA\\\"},{\\\"type\\\":0,\\\"label\\\":\\\"Please type here...\\\",\\\"description\\\":\\\"Text Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"Sample text value\\\"},{\\\"type\\\":1,\\\"label\\\":\\\"Please type here...\\\",\\\"description\\\":\\\"Larger Text Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"This is a longer text that spans multiple lines.\\\\nIt can contain paragraphs and more detailed information.\\\"},{\\\"type\\\":2,\\\"label\\\":null,\\\"description\\\":\\\"Checkbox
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":true},{\\\"type\\\":3,\\\"label\\\":null,\\\"description\\\":\\\"Radio Button
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"radioOptions\\\":[\\\"Option 1\\\",\\\"Option 2\\\",\\\"Option 3\\\"],\\\"value\\\":\\\"Option 2\\\"},{\\\"type\\\":4,\\\"label\\\":\\\"Please enter your email...\\\",\\\"description\\\":\\\"Email Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"secondary@example.com\\\"},{\\\"type\\\":5,\\\"label\\\":\\\"Please enter your phone...\\\",\\\"description\\\":\\\"Phone Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"+15551234567\\\"},{\\\"type\\\":7,\\\"label\\\":null,\\\"description\\\":\\\"Attachments Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":[{\\\"2fa02152-beae-40f2-b688-df3216ab6b35\\\":\\\"medical_records.pdf\\\"}]}]\"\n}"},"url":"https://api.calendesk.com/api/user/bookings","description":"This endpoint allows you to create a booking (make an appointment).
\nEach custom field object in the array has the following structure:
\n[\n {\n \"type\": 1,\n \"label\": \"Please type here...\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"Additional Information\"\n },\n {\n \"type\": 6,\n \"label\": null,\n \"description\": \"Address\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"123 Main Street, Apt 4B, New York, NY 10001, USA\"\n },\n {\n \"type\": 0,\n \"label\": \"Please type here...\",\n \"description\": \"Text Field\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"Sample text value\"\n },\n {\n \"type\": 1,\n \"label\": \"Please type here...\",\n \"description\": \"<p>Larger Text Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"This is a longer text that spans multiple lines.\\nIt can contain paragraphs and more detailed information.\"\n },\n {\n \"type\": 2,\n \"label\": null,\n \"description\": \"<p>Checkbox</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": true\n },\n {\n \"type\": 3,\n \"label\": null,\n \"description\": \"<p>Radio Button</p>\",\n \"required\": false,\n \"equal\": null,\n \"radioOptions\": [\"Option 1\", \"Option 2\", \"Option 3\"],\n \"value\": \"Option 2\"\n },\n {\n \"type\": 4,\n \"label\": \"Please enter your email...\",\n \"description\": \"<p>Email Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"secondary@example.com\"\n },\n {\n \"type\": 5,\n \"label\": \"Please enter your phone...\",\n \"description\": \"<p>Phone Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"+15551234567\"\n },\n {\n \"type\": 7,\n \"label\": null,\n \"description\": \"<p>Attachments Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": [\n {\"2fa02152-beae-40f2-b688-df3216ab6b35\": \"medical_records.pdf\"}\n ]\n }\n ]\n\nImportant Notes:
\nThe entire array must be stringified when sent in the request
\nFile uploads (type 7) require prior upload to the /files/sandbox/upload endpoint
\nThe files are associated with the booking after creation
\nEmpty or null values are allowed for non-required fields
\nAddress
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"123 Main Street, Apt 4B, New York, NY 10001, USA\\\"},{\\\"type\\\":0,\\\"label\\\":\\\"Please type here...\\\",\\\"description\\\":\\\"Text Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"Sample text value\\\"},{\\\"type\\\":1,\\\"label\\\":\\\"Please type here...\\\",\\\"description\\\":\\\"Larger Text Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"This is a longer text that spans multiple lines.\\\\nIt can contain paragraphs and more detailed information.\\\"},{\\\"type\\\":2,\\\"label\\\":null,\\\"description\\\":\\\"Checkbox
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":true},{\\\"type\\\":3,\\\"label\\\":null,\\\"description\\\":\\\"Radio Button
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"radioOptions\\\":[\\\"Option 1\\\",\\\"Option 2\\\",\\\"Option 3\\\"],\\\"value\\\":\\\"Option 2\\\"},{\\\"type\\\":4,\\\"label\\\":\\\"Please enter your email...\\\",\\\"description\\\":\\\"Email Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"secondary@example.com\\\"},{\\\"type\\\":5,\\\"label\\\":\\\"Please enter your phone...\\\",\\\"description\\\":\\\"Phone Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"+15551234567\\\"},{\\\"type\\\":7,\\\"label\\\":null,\\\"description\\\":\\\"Attachments Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":[{\\\"2fa02152-beae-40f2-b688-df3216ab6b35\\\":\\\"medical_records.pdf\\\"}]}]\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/user/bookings/v2","description":"This endpoint allows users to create bookings for specified services and employees. The request requires user details and booking data, including employee and service information.
\nEach custom field object in the array has the following structure:
\n[\n {\n \"type\": 1,\n \"label\": \"Please type here...\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"Additional Information\"\n },\n {\n \"type\": 6,\n \"label\": null,\n \"description\": \"Address\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"123 Main Street, Apt 4B, New York, NY 10001, USA\"\n },\n {\n \"type\": 0,\n \"label\": \"Please type here...\",\n \"description\": \"Text Field\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"Sample text value\"\n },\n {\n \"type\": 1,\n \"label\": \"Please type here...\",\n \"description\": \"<p>Larger Text Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"This is a longer text that spans multiple lines.\\nIt can contain paragraphs and more detailed information.\"\n },\n {\n \"type\": 2,\n \"label\": null,\n \"description\": \"<p>Checkbox</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": true\n },\n {\n \"type\": 3,\n \"label\": null,\n \"description\": \"<p>Radio Button</p>\",\n \"required\": false,\n \"equal\": null,\n \"radioOptions\": [\"Option 1\", \"Option 2\", \"Option 3\"],\n \"value\": \"Option 2\"\n },\n {\n \"type\": 4,\n \"label\": \"Please enter your email...\",\n \"description\": \"<p>Email Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"secondary@example.com\"\n },\n {\n \"type\": 5,\n \"label\": \"Please enter your phone...\",\n \"description\": \"<p>Phone Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"+15551234567\"\n },\n {\n \"type\": 7,\n \"label\": null,\n \"description\": \"<p>Attachments Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": [\n {\"2fa02152-beae-40f2-b688-df3216ab6b35\": \"medical_records.pdf\"}\n ]\n }\n ]\n\nImportant Notes:
\nThe entire array must be stringified when sent in the request
\nFile uploads (type 7) require prior upload to the /files/sandbox/upload endpoint
\nThe files are associated with the booking after creation
\nEmpty or null values are allowed for non-required fields
\nAddress
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"123 Main Street, Apt 4B, New York, NY 10001, USA\\\"},{\\\"type\\\":0,\\\"label\\\":\\\"Please type here...\\\",\\\"description\\\":\\\"Text Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"Sample text value\\\"},{\\\"type\\\":1,\\\"label\\\":\\\"Please type here...\\\",\\\"description\\\":\\\"Larger Text Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"This is a longer text that spans multiple lines.\\\\nIt can contain paragraphs and more detailed information.\\\"},{\\\"type\\\":2,\\\"label\\\":null,\\\"description\\\":\\\"Checkbox
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":true},{\\\"type\\\":3,\\\"label\\\":null,\\\"description\\\":\\\"Radio Button
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"radioOptions\\\":[\\\"Option 1\\\",\\\"Option 2\\\",\\\"Option 3\\\"],\\\"value\\\":\\\"Option 2\\\"},{\\\"type\\\":4,\\\"label\\\":\\\"Please enter your email...\\\",\\\"description\\\":\\\"Email Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"secondary@example.com\\\"},{\\\"type\\\":5,\\\"label\\\":\\\"Please enter your phone...\\\",\\\"description\\\":\\\"Phone Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":\\\"+15551234567\\\"},{\\\"type\\\":7,\\\"label\\\":null,\\\"description\\\":\\\"Attachments Field
\\\",\\\"required\\\":false,\\\"equal\\\":null,\\\"value\\\":[{\\\"2fa02152-beae-40f2-b688-df3216ab6b35\\\":\\\"medical_records.pdf\\\"}]}]\"\n }\n ]\n}"},"url":"https://api.calendesk.com/api/user/bookings/v2/auth","description":"This endpoint allows authenticated users to create bookings for specified services and employees. The request must include a valid Bearer token in the Authorization header, along with the necessary booking details in the request body.
Each custom field object in the array has the following structure:
\n[\n {\n \"type\": 1,\n \"label\": \"Please type here...\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"Additional Information\"\n },\n {\n \"type\": 6,\n \"label\": null,\n \"description\": \"Address\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"123 Main Street, Apt 4B, New York, NY 10001, USA\"\n },\n {\n \"type\": 0,\n \"label\": \"Please type here...\",\n \"description\": \"Text Field\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"Sample text value\"\n },\n {\n \"type\": 1,\n \"label\": \"Please type here...\",\n \"description\": \"<p>Larger Text Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"This is a longer text that spans multiple lines.\\nIt can contain paragraphs and more detailed information.\"\n },\n {\n \"type\": 2,\n \"label\": null,\n \"description\": \"<p>Checkbox</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": true\n },\n {\n \"type\": 3,\n \"label\": null,\n \"description\": \"<p>Radio Button</p>\",\n \"required\": false,\n \"equal\": null,\n \"radioOptions\": [\"Option 1\", \"Option 2\", \"Option 3\"],\n \"value\": \"Option 2\"\n },\n {\n \"type\": 4,\n \"label\": \"Please enter your email...\",\n \"description\": \"<p>Email Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"secondary@example.com\"\n },\n {\n \"type\": 5,\n \"label\": \"Please enter your phone...\",\n \"description\": \"<p>Phone Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": \"+15551234567\"\n },\n {\n \"type\": 7,\n \"label\": null,\n \"description\": \"<p>Attachments Field</p>\",\n \"required\": false,\n \"equal\": null,\n \"value\": [\n {\"2fa02152-beae-40f2-b688-df3216ab6b35\": \"medical_records.pdf\"}\n ]\n }\n ]\n\nImportant Notes:
\nThe entire array must be stringified when sent in the request
\nFile uploads (type 7) require prior upload to the /files/sandbox/upload endpoint
\nThe files are associated with the booking after creation
\nEmpty or null values are allowed for non-required fields
\nThis endpoint allows you to cancel active bookings.
\nThe status of booking will be updated to cancelled.
This endpoint allows you to retrieve a booking by its control. It is useful when you need to access specific information about a booking but don't have full access to the API.
GET https://api.calendesk.com/api/user/bookings/v2/control/abc123\n\nThe response will contain the booking information associated with the provided control ID.
Example response:
\n{\n \"id\": 4527,\n \"employee_id\": 52,\n \"service_id\": 88,\n \"service_type_id\": null,\n \"start_date\": \"2023-09-01\",\n \"end_date\": \"2023-09-01\",\n \"start_time\": \"14:00\",\n \"end_time\": \"15:00\",\n \"starts_at\": \"2023-09-01T12:00:00+00:00\",\n \"ends_at\": \"2023-09-01T13:00:00+00:00\",\n \"customer_time_zone\": null,\n \"group_id\": null,\n \"multi_slot_group_id\": null,\n \"recurrence_params\": null,\n \"status\": \"cancelled\",\n \"control\": \"7aaf1f7a-44f5-4f9d-976b-dcdc1c92fa56\",\n \"custom_fields\": null,\n \"paid\": false,\n \"payment_method\": null,\n \"payment_transaction\": null,\n \"paid_with_user_subscription_id\": null,\n \"service\": {\n \"id\": 88,\n \"category_id\": 24,\n \"name\": \"Online meeting\",\n \"description\": null,\n \"upselling_description\": \"<p class='preserveHtml' class='preserveHtml' style=\\\"text-align: center\\\">{{#if [USER_NOT_LOGGED]}}</p><p class='preserveHtml' class='preserveHtml' style=\\\"text-align: center\\\"><strong class='preserveHtml' class='preserveHtml' class='preserveHtml'>Please login to use packages.</b></p><p class='preserveHtml' class='preserveHtml' style=\\\"text-align: center\\\">[BUTTON_ACTION={\\\"action\\\":\\\"login\\\", \\\"text\\\": \\\"Log in\\\", \\\"outline\\\": true, \\\"color\\\": \\\"red\\\"}] [BUTTON_ACTION={\\\"action\\\":\\\"signup\\\", \\\"text\\\": \\\"Sign up\\\", \\\"outline\\\": true, \\\"color\\\": \\\"primary\\\"}]</p><p class='preserveHtml' class='preserveHtml' style=\\\"text-align: center\\\"><strong class='preserveHtml' class='preserveHtml' class='preserveHtml'>Buy our packages!</b></p><p class='preserveHtml' class='preserveHtml' style=\\\"text-align: center\\\">[CUSTOM_BUTTON={\\\"text\\\":\\\"Buy a package\\\", \\\"url\\\":\\\"https://mywebsite.com/buy\\\", \\\"newTab\\\":true, \\\"outline\\\":false, \\\"color\\\":\\\"primary\\\"}]</p><p class='preserveHtml' class='preserveHtml' style=\\\"text-align: center\\\">{{/if}}</p>\",\n \"booking_time_before\": 0,\n \"cancel_time_before\": 0,\n \"change_time_before\": 0,\n \"max_people\": 1,\n \"tax\": null,\n \"wants_invoice\": false,\n \"only_subscriptions\": false,\n \"duration\": 60,\n \"slots_every\": 60,\n \"break_time_before\": 0,\n \"break_time_after\": 0,\n \"price\": 10000,\n \"allow_dynamic_duration\": true,\n \"allow_online_payment\": true,\n \"awaiting_booking_payment_time\": 30,\n \"payment_required\": true,\n \"status\": \"active\",\n \"order_position\": \"1\",\n \"default_booking_status\": \"approved\",\n \"default_image\": {\n \"id\": 6109,\n \"name\": \"/calendesk-dev/f85356b6-9470-45cf-ad60-90bb4a4ccce4/62dd89043cf82.jpg\",\n \"user_image_id\": 11\n },\n \"category\": {\n \"id\": 24,\n \"name\": \"Consultations\",\n \"status\": \"active\",\n \"order_position\": \"65535\"\n },\n \"employees\": [\n {\n \"id\": 52,\n \"title\": null,\n \"description\": null,\n \"facebook\": null,\n \"instagram\": null,\n \"youtube\": null,\n \"twitter\": null,\n \"user\": {\n \"id\": 860,\n \"name\": \"Test\",\n \"surname\": \"Test\",\n \"status\": \"active\",\n \"default_image\": {\n \"id\": 7442,\n \"name\": \"/demo/placeholder.jpg\",\n \"user_image_id\": null\n }\n },\n \"services\": []\n }\n ],\n \"types\": [],\n \"locations\": [\n {\n \"id\": 103,\n \"type\": 2,\n \"data\": \"+48500123456\"\n },\n {\n \"id\": 104,\n \"type\": 3,\n \"data\": null\n },\n {\n \"id\": 108,\n \"type\": 6,\n \"data\": null\n },\n {\n \"id\": 109,\n \"type\": 7,\n \"data\": null\n },\n {\n \"id\": 110,\n \"type\": 8,\n \"data\": null\n },\n {\n \"id\": 148,\n \"type\": 5,\n \"data\": null\n }\n ],\n \"durations_range\": {\n \"from\": 60,\n \"to\": 60\n },\n \"prices_range\": {\n \"from\": 10000,\n \"to\": 10000\n }\n },\n \"service_type\": null,\n \"employee\": {\n \"id\": 52,\n \"title\": null,\n \"description\": null,\n \"facebook\": null,\n \"instagram\": null,\n \"youtube\": null,\n \"twitter\": null,\n \"user\": {\n \"id\": 860,\n \"name\": \"Test\",\n \"surname\": \"Test\",\n \"status\": \"active\",\n \"default_image\": {\n \"id\": 7442,\n \"name\": \"/demo/placeholder.jpg\",\n \"user_image_id\": null\n }\n },\n \"services\": []\n },\n \"location\": {\n \"id\": 103,\n \"type\": 2,\n \"data\": \"+48500123456\"\n },\n \"google_meet_url\": null,\n \"zoom_join_url\": null,\n \"teams_url\": null,\n \"skype_url\": null,\n \"customer_whatsapp_url\": null,\n \"employee_whatsapp_url\": null,\n \"simple_store_products\": []\n}\n\nThis endpoint allows you to cancel a booking by its control. It is useful when you need to cancel a booking but don't have full access to the API.
PUT https://api.calendesk.com/api/user/bookings/v2/control/abc123/cancel\n\nThis endpoint allows you to fetch available employees.
\n","urlObject":{"path":["api","employees"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0b00d516-fa52-41ec-8dd0-c978853476a2"}],"id":"f6212ac2-f5e3-42a0-a24f-f7e5bc12cd1c","_postman_id":"f6212ac2-f5e3-42a0-a24f-f7e5bc12cd1c","description":""},{"name":"Newsletter","item":[{"name":"Newsletter","id":"9f70fc31-25e7-4a10-83b7-e6a655119e3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"Content-Type","value":"application/json"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\" : \"andrzej@calendesk.pl\"\n}"},"url":"https://api.calendesk.com/api/newsletter","description":"This endpoint allows you to add an email to newsletter.
\n","urlObject":{"path":["api","newsletter"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9f70fc31-25e7-4a10-83b7-e6a655119e3c"},{"name":"Newsletter resend","id":"214a7303-8fc3-4375-849f-38649d8c0413","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"Content-Type","value":"application/json"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.calendesk.com/api/newsletter/resend/andrzej@calendesk.pl","description":"This endpoint allows you to add an email to newsletter.
\n","urlObject":{"path":["api","newsletter","resend","andrzej@calendesk.pl"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"214a7303-8fc3-4375-849f-38649d8c0413"},{"name":"Newsletter subscribe","id":"6e69ce2b-c0d3-4516-a180-003edafc611f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"Content-Type","value":"application/json"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.calendesk.com/api/newsletter/subscribe/{{activationToken}}","description":"This endpoint allows you to add an email to newsletter.
\n","urlObject":{"path":["api","newsletter","subscribe","{{activationToken}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e69ce2b-c0d3-4516-a180-003edafc611f"}],"id":"c04183a2-bf16-462e-bfd0-dab5baa3adc1","_postman_id":"c04183a2-bf16-462e-bfd0-dab5baa3adc1","description":""},{"name":"Settings","item":[{"name":"Settings Web","id":"cffcf9ec-4ea3-4eff-921b-3789f0082006","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/settings/web","description":"This endpoint allows you to fetch all configuration for the API's client. It should be the first call since the client has started.
\nThis endpoint allows you to fetch categories with services. The response will use pagination.
\n","urlObject":{"path":["api","v2","categories","services"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"58a0bad2-6911-4bfa-960b-b278e42ca60c"},{"name":"Categories","id":"ace8c1b7-cb64-43b8-bffb-1107e2a84b75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/categories","description":"This endpoint allows you to fetch available categories.
\n","urlObject":{"path":["api","categories"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ace8c1b7-cb64-43b8-bffb-1107e2a84b75"}],"id":"8c434058-e02b-4041-bb02-704230dc0a67","_postman_id":"8c434058-e02b-4041-bb02-704230dc0a67","description":""},{"name":"Stripe","item":[{"name":"Get Stripe Account","id":"1718f1b8-ccdf-4d1e-83b7-48997ebbfdd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."},{"key":"X-Tenant","type":"text","value":"{{tenant}}"}],"body":{"mode":"raw","raw":"{\n \"payment_method_identifier\": \"pm_1Ha67PAR0zEPlIBeuMDHZsY6\",\n \"plan_period_id\": 3\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/stripe/connect/account","urlObject":{"path":["api","stripe","connect","account"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1718f1b8-ccdf-4d1e-83b7-48997ebbfdd8"},{"name":"Create Stripe Payment Checkout For Booking","id":"2d5bdbfd-26e1-4a34-9c9c-1f36f08f6d98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"booking_ids\": [123],\n \"promo_code\" : \"20offm\",\n \"success_url\" : \"https://calendesk.com/success\",\n \"cancel_url\" : \"https://calendesk.com/fail\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/stripe/connect/payment/checkout/bookings","description":"This endpoint creates a Stripe Checkout session for the provided booking IDs and promo code, returning a session URL for the payment flow.
\nPOST https://api.calendesk.com/api/stripe/connect/payment/checkout/bookings
{\n \"booking_ids\": [123],\n \"promo_code\": \"promo20\",\n \"success_url\": \"https://calendesk.com/success\",\n \"cancel_url\": \"https://calendesk.com/fail\"\n}\n\n{\n \"session_id\": \"cs_test_a1JPbGOGh2SSh4N5fwizmknAvsgGOGiCzMydhvCFldJBVzMliCnJ2bfgYA\",\n \"url\": \"https://checkout.stripe.com/c/pay/cs_test_a1JPbGOGh2SSh4N5fwizmknAvsgGOGiCzMydhvCFldJBVzMliCnJ2bfgYA#fid...\",\n \"success_url\": \"https://example-success.com\",\n \"cancel_url\": \"https://example-cancel.com\",\n \"expires_at\": 1736948686,\n \"locale\": \"en\",\n \"payment_status\": \"unpaid\",\n \"customer\": \"cus_xxxxxxxxxxxxxx\",\n \"amount_total\": 80000,\n \"amount_subtotal\": 100000,\n \"currency\": \"usd\",\n \"total_details\": {\n \"amount_discount\": 20000,\n \"amount_shipping\": 0,\n \"amount_tax\": 0\n }\n}\nThis API endpoint is designed for clients to create a subscription by providing a subscription ID and optionally applying a coupon code for discounts. It simplifies the process of subscribing to services from the client-side, enabling users to easily manage their subscriptions and benefit from promotional offers.
\nEndpoint: POST https://api.calendesk.com/api/subscriptions/{{subscriptionID}}
Clients need to submit a JSON object with the following information to create a subscription and apply any available discounts:
\n{\n \"coupon\": \"50off\"\n}\n\nBy accessing this endpoint, clients have the ability to initiate a subscription to a particular service identified by the subscriptionID in the URL. The optional coupon key allows clients to take advantage of special offers or discounts that may be available, reducing the overall cost of the subscription. See https://calendesk.com/help/article/how-do-you-create-discount-codes/
The use of a coupon is entirely optional; clients can choose to omit this field if they do not have a coupon code or if they prefer to subscribe at the regular rate. When a coupon is applied, the system automatically calculates the discount and adjusts the subscription cost accordingly.
\n","urlObject":{"path":["api","subscriptions","{{subscriptionID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9093ea8f-f660-4374-9fb9-3387834a3a5a"},{"name":"Cancel User Subscription","id":"f9ba61f1-6788-4608-8f1c-3e89ca72a7b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"Authorization","type":"text","value":"Bearer {{token}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"https://api.calendesk.com/api/user/subscriptions/1/cancel","urlObject":{"path":["api","user","subscriptions","1","cancel"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f9ba61f1-6788-4608-8f1c-3e89ca72a7b5"}],"id":"7800451e-78f4-4d92-a129-e5600adf457d","_postman_id":"7800451e-78f4-4d92-a129-e5600adf457d","description":""},{"name":"Token","item":[{"name":"Generate Auth Token","id":"4d6344fc-429f-4ad8-814d-7aa3c8c2db0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"maciej@cupial.eu\",\n\t\"password\": \"demo12345A1!\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/auth/login","description":"This endpoint allows you to create an auth token, which will authorize you in other requests.
\nAdd to your headers the token you will receive.
\n\n\n","urlObject":{"path":["api","auth","login"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d6344fc-429f-4ad8-814d-7aa3c8c2db0e"},{"name":"Destroy Access Token","id":"d5607d71-cba3-449d-8754-99cd5e61abb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/auth/logout","description":"Authorization Bearer token
\n
This endpoint allows you to invalidate current auth token.
\n","urlObject":{"path":["api","auth","logout"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5607d71-cba3-449d-8754-99cd5e61abb8"},{"name":"Refresh Access Token","id":"1a81bad7-3084-417f-b996-d9e5c2395425","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"refresh_token\": \"{{refreshToken}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/auth/token/refresh","description":"This endpoint allows you to refresh an auth token, the request will generate another valid token.
\n","urlObject":{"path":["api","auth","token","refresh"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1a81bad7-3084-417f-b996-d9e5c2395425"},{"name":"Validate Access Token","id":"d07dc31a-c017-4314-8792-9f3ef305c8c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"access_token\": \"{{token}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/auth/token/validate","description":"This endpoint allows you to validate an auth token.
\n","urlObject":{"path":["api","auth","token","validate"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d07dc31a-c017-4314-8792-9f3ef305c8c0"}],"id":"3d38df81-6e24-48c6-b7a9-428034632922","_postman_id":"3d38df81-6e24-48c6-b7a9-428034632922","description":""},{"name":"User","item":[{"name":"Activate User's Account","id":"d8afdc4c-00e1-4e69-a595-14c556c87382","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/auth/signup/activate/{{activationToken}}","description":"This endpoint allows you to activate user's account. The user should receive an email with a link which will contain the activation token.
\n","urlObject":{"path":["api","auth","signup","activate","{{activationToken}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d8afdc4c-00e1-4e69-a595-14c556c87382"},{"name":"Create User","id":"f6b415b5-000f-48c9-ad5d-d56c553adf57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\" : \"Maciej\",\n\t\"surname\" : \"Testowy\",\n\t\"email\" : \"maciej@calendesk.com\",\n\t\"default_phone\" : \"+48500123456\",\n\t\"password\" : \"test12345\",\n\t\"default_address\" : {\n \"name\": \"ABC SA\",\n \"street\": \"Testowa 1/2\",\n \"postal_code\": \"00:001\",\n\t\t\"country_iso_code\" : \"pl\",\n\t\t\"city\" : \"Warsaw\",\n \"vat_iso_prefix\": \"PL\",\n \"tax_number\": \"5783137225\"\n\t}\n}"},"url":"https://api.calendesk.com/api/auth/signup","description":"This endpoint allows you to create a new user, which will be able to login to the user's panel (website for tenant's clients) and mobile app (mobile app for tenant's clients).
\n","urlObject":{"path":["api","auth","signup"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f6b415b5-000f-48c9-ad5d-d56c553adf57"},{"name":"Resend Activation Link","id":"940c1258-bcf8-4d31-96f1-643d950601d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/auth/signup/{{email}}/resend-activation-link","description":"This endpoint allows you to resend an activation token. The user will receive an email with a link which will contain the activation token.
\n","urlObject":{"path":["api","auth","signup","{{email}}","resend-activation-link"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"940c1258-bcf8-4d31-96f1-643d950601d4"},{"name":"Upload User's Picture","id":"7946d106-2535-4ee5-9175-f54bd04eb920","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","value":null}]},"url":"https://api.calendesk.com/api/user/upload/picture","description":"This endpoint allows you to replace logged user's picture.
\nThis request will remove an old avatar and set the new one
\nRemember about setting Conent-Type to application/x-www-form-urlencoded.
\nThe default limit is 10240 KB, the size will be limited to 600x600 px.
This endpoint allows you to reset user's password. The user should receive an email with a link which will contain the reset password token.
\n","urlObject":{"path":["api","auth","login","reset-password","{{resetPasswordToken}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a73df71a-fc8c-455f-a172-1346c41f8c11"},{"name":"Remind User's Password","id":"7db1fa9c-5ca0-47bc-81de-580d3237632b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/auth/login/{{email}}/remind-password/1","description":"This endpoint allows you to send a link for password reset. The user will receive an email with a link which will contain the reset password token. The endpoint will return success even if the email doesn't exist in database.
\n","urlObject":{"path":["api","auth","login","{{email}}","remind-password","1"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7db1fa9c-5ca0-47bc-81de-580d3237632b"},{"name":"User's Data","id":"28ed6739-c745-4151-8d97-4fbd210444fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Api-Key","value":"{{apiKey}}","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/v2/user","description":"This endpoint allows you to fetch logged user's data.
\n","urlObject":{"path":["api","v2","user"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"28ed6739-c745-4151-8d97-4fbd210444fd"},{"name":"Delete User","id":"514155fb-a1ef-4805-8857-86e3f6176ec1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/user","description":"This endpoint allows you to fetch logged user's data.
\n","urlObject":{"path":["api","user"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"514155fb-a1ef-4805-8857-86e3f6176ec1"},{"name":"Update User's Data","id":"25281d00-5ca1-410b-afa2-3e637254bd22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"gender\":\"male\",\n \"name\" : \"Demo\",\n \"surname\" : \"Calendesk\",\n \"default_address\": {\n \t\"name\": \"John Demo\",\n \t\"street\": \"Test Street 12/1\",\n \t\"postal_code\": \"01-000\",\n \t\"city\": \"Warsaw\",\n \t\"country_iso_code\": \"pl\",\n \t\"tax_number\": \"1234567890\"\n },\n \"default_phone\" : \"+48500123456\"\n}"},"url":"https://api.calendesk.com/api/user","description":"This endpoint allows you to update logged user's data.
\n","urlObject":{"path":["api","user"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"25281d00-5ca1-410b-afa2-3e637254bd22"},{"name":"Update User's Preferencies","id":"ae4416fc-e371-4489-82c2-25f5cca665ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email_notification_booking_created\": true,\n \"email_notification_booking_updated\": true,\n \"email_notification_booking_deleted\": true,\n \"email_notification_booking_reminder\": true,\n \"sms_notification_booking_created\": true,\n \"sms_notification_booking_updated\": true,\n \"sms_notification_booking_deleted\": true,\n \"sms_notification_booking_reminder\": true\n \n}"},"url":"https://api.calendesk.com/api/user/preferences","description":"This endpoint allows you to update logged user's preferences.
\n","urlObject":{"path":["api","user","preferences"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae4416fc-e371-4489-82c2-25f5cca665ca"},{"name":"User's Bookings","id":"a1a9d243-0144-4e0f-86c0-f4d3d6c4e8d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/user/bookings","description":"This endpoint allows you to fetch user's bookings.
\n","urlObject":{"path":["api","user","bookings"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a1a9d243-0144-4e0f-86c0-f4d3d6c4e8d4"},{"name":"User's Bookings Filters","id":"4293d185-6139-43f1-813e-8082cf0851fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/user/bookings/filters","description":"This endpoint allows you to fetch user's bookings filters (they are dynamic).
\n","urlObject":{"path":["api","user","bookings","filters"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4293d185-6139-43f1-813e-8082cf0851fa"},{"name":"Get User Subscriptions","id":"511df67a-4071-430a-aae1-74cf641394fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"X-Api-Key","type":"text","value":"{{apiKey}}"}],"url":"https://api.calendesk.com/api/v2/user/subscriptions","urlObject":{"path":["api","v2","user","subscriptions"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"511df67a-4071-430a-aae1-74cf641394fe"}],"id":"2c9e04c7-9fd0-4051-9e31-270aa95ac602","_postman_id":"2c9e04c7-9fd0-4051-9e31-270aa95ac602","description":""},{"name":"User payments","item":[{"name":"Get Simple Store Product Payment Transactions","id":"aaca7586-383a-44eb-8b4c-b9651d203b3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.calendesk.com/api/simple-store/product/transaction","urlObject":{"path":["api","simple-store","product","transaction"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"aaca7586-383a-44eb-8b4c-b9651d203b3f"},{"name":"Get User Subscription Payment Transactions","id":"d06703b9-fccb-4a9e-857d-0b62edcb9b64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"Authorization","type":"text","value":"Bearer {{token}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"https://api.calendesk.com/api/user/subscriptions/transactions","urlObject":{"path":["api","user","subscriptions","transactions"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d06703b9-fccb-4a9e-857d-0b62edcb9b64"},{"name":"Get Booking Payment Transactions","id":"ed2d09cf-478d-462d-a907-6085b70957df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"}],"url":"https://api.calendesk.com/api/payments/bookings","description":"This endpoint allows you to fetch booking payment transactions. The response will use pagination. You can filter your results using parameters.
\n","urlObject":{"path":["api","payments","bookings"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ed2d09cf-478d-462d-a907-6085b70957df"}],"id":"46947452-b579-420d-a2df-d2d669f9a3d3","_postman_id":"46947452-b579-420d-a2df-d2d669f9a3d3","description":""},{"name":"Website","item":[{"name":"Get Published Website","id":"e10df0d0-6ebd-4a89-b393-1819b5fa68c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"}],"url":"https://api.calendesk.com/api/website/v2/published/{{draftId}}","urlObject":{"path":["api","website","v2","published","{{draftId}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e10df0d0-6ebd-4a89-b393-1819b5fa68c3"},{"name":"Get Published Website Page Sections","id":"4efe365b-e35c-4f24-b062-ffae2e9db5c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"}],"url":"https://api.calendesk.com/api/website/v2/published/{{draftUuid}}/pages/{{pageId}}/sections","urlObject":{"path":["api","website","v2","published","{{draftUuid}}","pages","{{pageId}}","sections"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4efe365b-e35c-4f24-b062-ffae2e9db5c2"},{"name":"Get Published Website Page By Id","id":"2ab2f70d-d431-4082-8288-f465a1288692","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"}],"url":"https://api.calendesk.com/api/website/v2/published/{{draftUuid}}/pages/{{pageId}}","urlObject":{"path":["api","website","v2","published","{{draftUuid}}","pages","{{pageId}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2ab2f70d-d431-4082-8288-f465a1288692"}],"id":"1125ed69-07d9-464d-813b-326bc560416a","_postman_id":"1125ed69-07d9-464d-813b-326bc560416a","description":""},{"name":"Beta","item":[{"name":"[BETA] Reviews","id":"538d6075-cfa2-4878-9947-84cc7c98e6a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/reviews","description":"This endpoint allows you to fetch users reviews.
\n","urlObject":{"path":["api","reviews"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"538d6075-cfa2-4878-9947-84cc7c98e6a3"},{"name":"[BETA] Create Review","id":"5df7e0a1-29c3-47ee-b5b7-59f81125eb11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\" : \"Aleksander\",\n\t\"description\" : \"This place is amazing!\",\n\t\"stars\" : 5\n}"},"url":"https://api.calendesk.com/api/reviews","description":"This endpoint allows you to create a simple review about tenant and its services. The review has to be accepted by admin before it appears.
This endpoint allows you to fetch categories with services. The response will use pagination.
\n","urlObject":{"path":["api","categories","services"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"53c1bcb3-eb3f-41c1-b052-14a1a1a764f0"},{"name":"Available Bookings Slot","id":"8e240483-d6bf-4484-bbbb-2c5d1d59b52e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/available-slots?service_id={{serviceID}}&service_type_id={{serviceTypeID}}&number_of_days={{numberOfDays}}&start_date={{startDate}}&required_time={{requiredTime}}","description":"This endpoint allows you to fetch available booking slots sorted by employees IDs.
\n","urlObject":{"path":["api","available-slots"],"host":["https://api.calendesk.com"],"query":[{"key":"service_id","value":"{{serviceID}}"},{"key":"service_type_id","value":"{{serviceTypeID}}"},{"key":"number_of_days","value":"{{numberOfDays}}"},{"key":"start_date","value":"{{startDate}}"},{"key":"required_time","value":"{{requiredTime}}"}],"variable":[]}},"response":[],"_postman_id":"8e240483-d6bf-4484-bbbb-2c5d1d59b52e"},{"name":"Translations","id":"c5493f2e-bfe3-45cc-b8ec-e2c2a2e273e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","type":"text","value":"{{tenant}}"},{"key":"Accept-Language","value":"{{language}}","type":"text"}],"url":"https://api.calendesk.com/api/translations/{{translationTypeID}}","description":"This endpoint allows you to fetch translations.
\n","urlObject":{"path":["api","translations","{{translationTypeID}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5493f2e-bfe3-45cc-b8ec-e2c2a2e273e6"},{"name":"Services","id":"dbc4ec4d-8fa1-4010-ad34-df310e3c2d8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/services","description":"This endpoint allows you to fetch all available services.\n
\nWe do you need to know?
\n\n\n
statusWe use different statuses for booking:
\n\n
\n- \n
waiting- The booking is waiting for approvement.- \n
payment- The booking is waiting for payment.- \n
approved- The booking is approved and waiting to done.- \n
cancelled- The booking is cancelled.- \n
done- The booking is done.
\n\n\n
allow_dynamic_durationIt says if the service can use dynamic time for booking (
\nrequired_timeatPOST https://api.calendesk.com/api/user/bookings)
\n\n\n
payment_requiredIt will be used in the future. So far we don't support payments.
\n
\n\n\n
default_booking_statusThis says which status booking will receive if will be created for this service. Status
\nwaitingmeans that tenant's admin has to approve it.
\n\n","urlObject":{"path":["api","services"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dbc4ec4d-8fa1-4010-ad34-df310e3c2d8d"}],"id":"c9c9b691-33d5-4890-87b2-4e019a7eafc1","_postman_id":"c9c9b691-33d5-4890-87b2-4e019a7eafc1","description":""},{"name":"Simple Store","item":[{"name":"Get simple Store Product","id":"b8f439c0-9113-4885-81b4-ef2bebd1c2de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"}],"url":"https://api.calendesk.com/api/simple-store/product/{{productId}}","description":"\n
typesSome services have types. It means you can't book just a service by its id, you need to choose which type you want to book as well.\nTypes have own price and duration.
\n
This endpoint allows you to fetch available booking slots sorted by employees IDs.
\n","urlObject":{"path":["api","simple-store","product","{{productId}}"],"host":["https://api.calendesk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b8f439c0-9113-4885-81b4-ef2bebd1c2de"}],"id":"a567d884-473a-4615-9c2b-f6721651dac0","_postman_id":"a567d884-473a-4615-9c2b-f6721651dac0","description":""},{"name":"Files","item":[{"name":"Get Files","id":"504b3270-2034-43f9-b780-995bbf688ede","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Requested-With","value":"XMLHttpRequest"},{"key":"X-Tenant","value":"{{tenant}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.calendesk.com/api/files","description":"GET https://api.calendesk.com/api/files
This endpoint allows you to get all user's files.
\nPOST https://api.calendesk.com/api/admin/files/upload
This endpoint allows you to upload a file to the system.
\n```http
POST https://api.calendesk.com/api/files/upload
Content-Type: multipart/form-data
{
\"file\": (binary file data)
}
POST https://api.calendesk.com/api/admin/files/upload
This endpoint allows you to upload a file to the system.
\n```http
POST https://api.calendesk.com/api/files/upload
Content-Type: multipart/form-data
{
\"file\": (binary file data)
}
DELETE https://api.calendesk.com/api/admin/files/{fileId}
This endpoint allows you to delete a specific file.
\nPATCH https://api.calendesk.com/api/admin/files/download/{fileId}
This endpoint allows you to update a specific file.
\nGET https://api.calendesk.com/api/admin/files/download/{fileId}
This endpoint allows you to download a specific file.
\nGET `https://api.calendesk.com/api/directories
\nThis endpoint allows you to get all user's file directories.
\nPOST https://api.calendesk.com/api/admin/directories
This endpoint allows you to create a directory for your files.
\n```json
{
\"name\": \"New Directory\",
\"parent_directory_id\": 5,
\"user_id\": 1
}
PATCH https://api.calendesk.com/api/admin/directories/{directoryId}
This endpoint allows you to update an existing directory.
\n```json
{
\"name\": \"Updated Directory Name\",
\"parent_directory_id\": 3,
\"user_id\": 1
}
DELETE https://api.calendesk.com/api/admin/directories/{directoryId}
This endpoint allows you to update an existing directory.
\n