Integrate advanced scheduling features with the our API – a versatile tool designed for seamless appointment booking and calendar management.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1487056","collectionId":"0b04d1c0-ea17-4408-bddf-f9b353a63d80","publishedId":"2sAY4x9MRe","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-11-01T13:47:27.000Z"},"item":[{"name":"Auth","item":[{"name":"Token","event":[{"listen":"test","script":{"id":"c53cd6e3-84bb-41e4-b874-5d3e723c707a","exec":["var jsonData = JSON.parse(responseBody);","pm.collectionVariables.set(\"accessToken\", jsonData.access_token);","var template = `","","","| Token Type | ","Expires In | ","Access Token | ","
|---|---|---|
| {{response.token_type}} | ","{{response.expires_in}} | ","{{response.access_token}} | ","
This endpoint is used to obtain a token by providing the necessary credentials.
\nMethod: POST
\nBase URL:
\nHeaders:
\ngrant_type (text, required): The type of grant being requested.
\nclient_id (text, required): The ID of the client.
\nclient_secret (text, required): The secret key of the client.
\nStatus: 200
\nContent-Type: application/json
\n{\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600,\n \"access_token\": \"*********\"\n}\n\nEnsure you add the client ID and client secret variables before running this request. You can find these values on the Configure page in the Dashboard.
\n","_postman_id":"bcfda98c-c919-4054-b83b-87985a7a58d5"},{"name":"Customer","item":[{"name":"Create Customer","event":[{"listen":"test","script":{"id":"2d9f6cf6-1e92-4a23-9a00-829fc1e5665e","exec":["pm.test(\"Successful POST request\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});",""],"type":"text/javascript","packages":{}}}],"id":"75ed0f2a-fd83-4cfb-8d12-626ee1ed6f0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"first_name\": \"John\",\n\t\"last_name\": \"Doe\",\n\t\"email\": \"john.doe@example.com\",\n\t\"phone\": \"+447855571605\",\n\t\"description\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v2/customers","description":"This is a POST request, submitting data to an API via the request body. This request submits JSON data, and the data is reflected in the response.
\nA successful POST request typically returns a 200 OK.
This is a PUT request and it is used to overwrite an existing piece of data. For instance, after you create an entity with a POST request, you may want to modify that later. You can do that using a PUT request. You typically identify the entity being updated by including an identifier in the URL (eg. id=1).
A successful PUT request typically returns a 200 OK, 201 Created, or 204 No Content response code.
This is a DELETE request, and it is used to delete data that was previously created via a POST request. You typically identify the entity being updated by including an identifier in the URL (eg. id=1).
A successful DELETE request typically returns a 200 OK, 202 Accepted, or 204 No Content response code.
ID of customer
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"86cac480-6503-426b-b223-8d9762b0e4c7","name":"Customer Not Found","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/api/v2/customers/{id}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 30 Oct 2024 12:21:09 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-Powered-By","value":"PHP/8.3.12","enabled":true},{"key":"X-Clockwork-Id","value":"1730290869-1576-516683924","enabled":true},{"key":"X-Clockwork-Version","value":"5.2.2","enabled":true},{"key":"Server-Timing","value":"app; dur=85.095882415771; desc=\"Application\", db; dur=0.53000450134277; desc=\"Database\"","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, POST, PUT, PATCH, DELETE","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, Access-Control-Allow-Credentials, access-control-allow-origin, Time-Zone, X-Requested-With","enabled":true},{"key":"Access-Control-Max-Age","value":"3600","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Customer not found\"\n}"},{"id":"f1e5e208-9f3e-4454-87ef-dd0dbfdccbc5","name":"Success Response","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/v2/customers/:id","host":[""],"path":["api","v2","customers",":id"],"query":[{"key":"","value":null,"type":"text","disabled":true}],"variable":[{"key":"id","value":"75","description":"Customer ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 30 Oct 2024 13:09:53 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-Powered-By","value":"PHP/8.3.12","enabled":true},{"key":"X-Clockwork-Id","value":"1730293793-4835-488760972","enabled":true},{"key":"X-Clockwork-Version","value":"5.2.2","enabled":true},{"key":"Server-Timing","value":"app; dur=101.19581222534; desc=\"Application\", db; dur=9.7665786743164; desc=\"Database\"","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Referrer-Policy","value":"no-referrer, strict-origin-when-cross-origin","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, POST, PUT, PATCH, DELETE","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, Access-Control-Allow-Credentials, access-control-allow-origin, Time-Zone, X-Requested-With","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"Access-Control-Max-Age","value":"3600","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"5f375bb2-17fc-45f1-9061-a9f6c1184d07"},{"name":"List Customers","id":"e6144be0-dd30-4928-b0e3-fa6a6c90c2a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"/api/v2/customers","description":"Retrieves a list of all customers. Supports filtering by email, first name, last name, and phone.
\npage (optional) — The page number to retrieve. Defaults to 1 if not specified.
limit (optional) — The number of customers to return per page. Defaults to 10.
email (optional) — Filters customers by their exact email address.
firstName (optional) — Filters customers by their exact first name.
lastName (optional) — Filters customers by their exact last name.
phoneNumber (optional) — Filters customers by their exact phone number. Must be URL-encoded.
This is a POST request that submits coupon data to the API via the request body in JSON format. If the request is successful, the API returns a 200 OK response with the newly created coupon's ID.
Coupons created through this endpoint can be applied to all services.
\nCoupon code (max 100 characters).
\nCoupon expiration date in Y-m-d format.
Type of discount applied. Valid values: discount (default) or deduction.
Coupon discount amount.
\nMaximum number of times the coupon can be used.
\nnull means no limit.
Maximum number of times a single user can use the coupon.
\nnull means no limit.
Minimum booking amount required to apply the coupon.
\nnull means no minimum amount.
This is a PATCH request and is used to partially update an existing coupon. In your PATCH request, only the parameters that are being updated need to be sent. If you don't include a parameter, the existing value for that parameter remains unchanged. The coupon to be updated is identified by including its unique identifier (e.g., id=1) in the URL.
A successful PATCH request typically returns a 200 OK or 204 No Content response code, indicating that the update was successful. If the coupon does not exist or there is an error with the request, an appropriate error response will be returned.
This is a DELETE request, and it is used to remove a previously created coupon. You typically identify the coupon to be deleted by including its unique identifier in the URL (e.g., id=1).
A successful DELETE request typically returns a 200 OK, 202 Accepted, or 204 No Content response code, indicating that the coupon has been successfully deleted. If the coupon does not exist or there is an error with the request, an appropriate error response will be returned.
Retrieves a list of all employees.
\nQuery Parameters:
\npage (optional) — The page number to retrieve. Defaults to 1 if not specified.
limit (optional) — The number of locations to return per page. Defaults to 10 if not specified.
Retrieves detailed information about a specific employee.
\n","urlObject":{"path":["api","v2","employees",":id"],"host":[""],"query":[],"variable":[{"type":"any","value":"ID of employee","key":"id"}]}},"response":[{"id":"fd3655f5-a81e-43a2-8186-a2a5eaea7159","name":"Get Employee Details","originalRequest":{"method":"GET","header":[{"key":"id","value":"1","type":"text"}],"url":"/api/v2/employees/1"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"phone_number\": \"+79021596518\",\n \"phone_country_code\": \"RU\",\n \"timezone\": \"Europe/Belgrade\"\n}"}],"_postman_id":"275fc651-67ba-4e55-b117-4bb9bd906af3"}],"id":"4d74ac45-1c5f-48e4-8b5d-d7ae9a6b9956","_postman_id":"4d74ac45-1c5f-48e4-8b5d-d7ae9a6b9956","description":""},{"name":"Locations","item":[{"name":"List Locations","id":"61fc37a1-5e57-479f-ac69-98794350f370","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"/api/v2/locations","description":"Retrieves a list of all locations.
\nQuery Parameters:
\npage (optional) — The page number to retrieve. Defaults to 1 if not specified.
limit (optional) — The number of locations to return per page. Defaults to 10 if not specified.
Retrieves detailed information about a specific location.
\n","urlObject":{"path":["api","v2","locations",":id"],"host":[""],"query":[],"variable":[{"type":"any","value":"ID of location","key":"id"}]}},"response":[{"id":"ee34c3b1-5f87-4c9b-8eb8-546c2bf25020","name":"Get Location Details","originalRequest":{"method":"GET","header":[],"url":"/api/v2/locations/123"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 123,\n \"name\": \"Downtown Branch\",\n \"phone_number\": \"+1234567890\",\n \"phone_country_code\": \"US\",\n \"address\": \"123 Main Street, City, Country\",\n \"latitude\": 40.712776,\n \"longitude\": -74.005974\n}"}],"_postman_id":"d5aa855d-3b4b-4a71-92d4-f5c968b5a8cc"}],"id":"014e8b7c-c6bc-429e-802b-cd105e429c07","_postman_id":"014e8b7c-c6bc-429e-802b-cd105e429c07","description":""},{"name":"Services","item":[{"name":"List Services","id":"d1a90e23-80b8-4016-991c-e9fc657425f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"/api/v2/services","description":"Retrieves a list of all services.
\nQuery Parameters:
\npage (optional) — The page number to retrieve. Defaults to 1 if not specified.
limit (optional) — The number of locations to return per page. Defaults to 10 if not specified.
Retrieves detailed information about a specific service.
\n","urlObject":{"path":["api","v2","services",":id"],"host":[""],"query":[],"variable":[{"type":"any","value":"ID of service","key":"id"}]}},"response":[{"id":"69b3d049-9033-469c-9e48-bda271d65c24","name":"Get Service Details","originalRequest":{"method":"GET","header":[],"url":"/api/v2/services/2"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 2,\n \"name\": \"Meditation\",\n \"duration\": 3600,\n \"buffer_time_before\": null,\n \"buffer_time_after\": 1200,\n \"price\": 120\n}"}],"_postman_id":"45158e08-ed1a-4530-94ce-004c5495705a"}],"id":"a1dcedf0-8e9e-4a76-a242-c6c6593f5149","_postman_id":"a1dcedf0-8e9e-4a76-a242-c6c6593f5149","description":""},{"name":"Appointments","item":[{"name":"List Appointments","id":"7b1d56c9-68c2-498d-98f7-55e6e18df172","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"/api/v2/appointments","description":"Retrieve Appointments
\nReturns a paginated list of appointments with optional filters for customer, employee, service, location, and status.
\npage (optional) — Page number to retrieve. Defaults to 1.
limit (optional) — Number of appointments per page. Defaults to 10.
customerId (optional) — Filter by customer ID.
\nemployeeId (optional) — Filter by employee ID.
\nserviceId (optional) — Filter by service ID.
\nlocationId (optional) — Filter by location ID.
\nstatus (optional) — Filter by appointment status. Valid values:
\napproved
pending
canceled
rejected
no_show
sort_by (optional) - Sort the appointments list. Allowed values:
\nstart_time — Sort by the appointment date and time
created_at — Sort by the appointment creation date and time
sort_order (optional) - Sort direction: asc | desc. Default is asc.
This operation permanently removes a specific appointment.
\nRetrieves a list of available times for params passed.
\nQuery Parameters:
\ncalendar_start_date (optional) — Specifies the start date for the returned time slots. If not provided, it defaults to the current date.
calendar_end_date (optional) — Specifies the end date for the returned time slots. If omitted, it defaults to 7 days after the calendar_start_date. The maximum supported range between start and end dates is 7 days.
service (optional) — ID of the service for which time slots are being requested.
employee (optional) — ID of the employee to filter available time slots.
location (optional) — ID of the location where the service will be provided.
additional_guest_count (optional) — Number of additional guests for group bookings.
This is a POST request, submitting data to an API via the request body. This request submits JSON data, and the data is reflected in the response.
\nA successful POST request typically returns a 200 OK.
service (id, required)
\nemployee (id, required)
\ndate (required)
\ntime (required)
\ncustomer (id, required)
\nstatus (number) 1 - approved, 2 - pending
\n