{ "item": [ { "name": "bookings.json", "description": "", "item": [ { "id": "5214de26-7043-40b3-8ab8-f780bc89eba5", "name": "All bookings", "request": { "name": "All bookings", "description": { "content": "Returns all non-cancelled bookings with optional sorting and pagination support.", "type": "text/plain" }, "url": { "path": [ "bookings.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Field to sort by (This can only be one of created_at,updated_at,start_at,end_at,customer_name,room_name)", "type": "text/plain" }, "key": "sort_by", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort order (ascending or descending) (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort_order", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ee9d3525-b51a-435e-8206-0e102a8fda86", "name": "successful operation", "originalRequest": { "url": { "path": [ "bookings.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Field to sort by (This can only be one of created_at,updated_at,start_at,end_at,customer_name,room_name)", "type": "text/plain" }, "key": "sort_by", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort order (ascending or descending) (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort_order", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n },\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e15f63ac-20d7-4e80-8087-ac96ff134361", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings.json" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Field to sort by (This can only be one of created_at,updated_at,start_at,end_at,customer_name,room_name)", "type": "text/plain" }, "key": "sort_by", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort order (ascending or descending) (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort_order", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0b00b67-fcf1-43ff-b961-00c7b0df6cc6", "name": "Create a booking", "request": { "name": "Create a booking", "description": { "content": "Create a new booking on Jammed as an admin.\n\nThis creates a booking in the same way as a staff member would from the admin dashboard.\n\nYou must provide **booking_details** with at least a `start_at`, `end_at`, `room_id`, and `price`.\n\nFor the customer, you can either:\n- Provide a `customer_id` to book for an existing customer\n- Provide `customer_details` with `name` and `email` to create a new customer inline\n\nOptionally provide `band_details` with a `name` to associate a group/band, and `extra_ids` to add extras to the booking.\n\nThe booking is created with source `manually_added` and platform `api_v2`.\n", "type": "text/plain" }, "url": { "path": [ "bookings.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"booking_details\": {\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"room_id\": \"\",\n \"price\": \"\"\n },\n \"customer_id\": \"\",\n \"customer_details\": {\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\"\n },\n \"band_details\": {\n \"name\": \"\"\n },\n \"band_code\": \"\",\n \"extra_ids\": [\n \"\",\n \"\"\n ],\n \"is_recording\": \"\",\n \"number_expected\": \"\",\n \"additional_notes\": \"\",\n \"send_email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "23b3daf8-6ee2-48fa-8abc-5f523019e2e6", "name": "Booking created", "originalRequest": { "url": { "path": [ "bookings.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"booking_details\": {\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"room_id\": \"\",\n \"price\": \"\"\n },\n \"customer_id\": \"\",\n \"customer_details\": {\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\"\n },\n \"band_details\": {\n \"name\": \"\"\n },\n \"band_code\": \"\",\n \"extra_ids\": [\n \"\",\n \"\"\n ],\n \"is_recording\": \"\",\n \"number_expected\": \"\",\n \"additional_notes\": \"\",\n \"send_email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9504e7d3-d34c-443c-ba35-d8eb06520b4a", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"booking_details\": {\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"room_id\": \"\",\n \"price\": \"\"\n },\n \"customer_id\": \"\",\n \"customer_details\": {\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\"\n },\n \"band_details\": {\n \"name\": \"\"\n },\n \"band_code\": \"\",\n \"extra_ids\": [\n \"\",\n \"\"\n ],\n \"is_recording\": \"\",\n \"number_expected\": \"\",\n \"additional_notes\": \"\",\n \"send_email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "84121e4c-809f-476b-b8e6-d4f6c2a109ff", "name": "Unprocessable - the booking parameters you provided are invalid", "originalRequest": { "url": { "path": [ "bookings.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"booking_details\": {\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"room_id\": \"\",\n \"price\": \"\"\n },\n \"customer_id\": \"\",\n \"customer_details\": {\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\"\n },\n \"band_details\": {\n \"name\": \"\"\n },\n \"band_code\": \"\",\n \"extra_ids\": [\n \"\",\n \"\"\n ],\n \"is_recording\": \"\",\n \"number_expected\": \"\",\n \"additional_notes\": \"\",\n \"send_email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "bookings", "description": "", "item": [ { "name": "{code}.json", "description": "", "item": [ { "id": "50845138-1dc6-4c82-93eb-e6ac2fe707be", "name": "Find a booking by code", "request": { "name": "Find a booking by code", "description": { "content": "Returns booking with the given code", "type": "text/plain" }, "url": { "path": [ "bookings", "{{code}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c45b9294-5a72-411c-a89c-f45ad8583e4e", "name": "successful operation", "originalRequest": { "url": { "path": [ "bookings", "{{code}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60f7e460-bd44-4f7e-a42d-ff3bbaec8162", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings", "{{code}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6435e46e-ec02-4604-8f10-c1f4838c56b2", "name": "Not found - Booking was not found", "originalRequest": { "url": { "path": [ "bookings", "{{code}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eeee508a-21ad-443c-9476-23739af7f0ee", "name": "Update a booking", "request": { "name": "Update a booking", "description": { "content": "Update an existing booking as an admin.\n\nThis uses the same booking update flow as staff members would from the admin dashboard.\n\nYou can update various booking details including time, room, pricing, customer information,\nand other booking attributes.\n\nThe booking is identified by its code (same as the GET endpoint).\n", "type": "text/plain" }, "url": { "path": [ "bookings", "{{code}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"room_id\": \"\",\n \"price\": \"\",\n \"additional_notes\": \"\",\n \"studio_notes\": \"\",\n \"number_expected\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5a69a754-a1b9-4e2d-abc5-b19b24d427a6", "name": "Booking updated successfully", "originalRequest": { "url": { "path": [ "bookings", "{{code}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"room_id\": \"\",\n \"price\": \"\",\n \"additional_notes\": \"\",\n \"studio_notes\": \"\",\n \"number_expected\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c62f1540-23b4-40a9-9afc-bb5b7d0923b0", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings", "{{code}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"room_id\": \"\",\n \"price\": \"\",\n \"additional_notes\": \"\",\n \"studio_notes\": \"\",\n \"number_expected\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "249faf2f-92a4-403a-aa29-9e8f1731b6ea", "name": "Not found - Booking was not found", "originalRequest": { "url": { "path": [ "bookings", "{{code}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"room_id\": \"\",\n \"price\": \"\",\n \"additional_notes\": \"\",\n \"studio_notes\": \"\",\n \"number_expected\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b81fb56f-0395-451f-a149-d5051834efbb", "name": "Unprocessable - the booking parameters you provided are invalid", "originalRequest": { "url": { "path": [ "bookings", "{{code}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"room_id\": \"\",\n \"price\": \"\",\n \"additional_notes\": \"\",\n \"studio_notes\": \"\",\n \"number_expected\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "cancelled.json", "description": "", "item": [ { "id": "9c80aafc-37c9-4aaf-a29b-ac3a866d6de4", "name": "Cancelled bookings", "request": { "name": "Cancelled bookings", "description": { "content": "Returns all cancelled bookings, ordered by cancellation date descending. Supports pagination.", "type": "text/plain" }, "url": { "path": [ "bookings", "cancelled.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4c8403f3-77eb-4900-9e08-9924cd63e2bc", "name": "successful operation", "originalRequest": { "url": { "path": [ "bookings", "cancelled.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n },\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8017142-5193-4329-a64f-8a7b83b4d2df", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings", "cancelled.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "started.json", "description": "", "item": [ { "id": "627dd6f7-66ae-408b-b15d-e3c3ffd481f5", "name": "Started bookings", "request": { "name": "Started bookings", "description": { "content": "Returns all upcoming bookings (starting in the future), ordered by start time descending. Supports pagination.", "type": "text/plain" }, "url": { "path": [ "bookings", "started.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2dc7e9dd-d66e-4831-978e-2046c59b35ed", "name": "successful operation", "originalRequest": { "url": { "path": [ "bookings", "started.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n },\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ba8dab9-84a6-4c18-9c93-e3f2cf1aee35", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings", "started.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "finished.json", "description": "", "item": [ { "id": "f5ed91de-4b9e-4d7d-b5b5-4151300ed816", "name": "Finished bookings", "request": { "name": "Finished bookings", "description": { "content": "Returns all bookings that have not yet ended, ordered by start time descending. Supports pagination.", "type": "text/plain" }, "url": { "path": [ "bookings", "finished.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8cb3207a-1aad-43f6-a2b8-66e0763ba650", "name": "successful operation", "originalRequest": { "url": { "path": [ "bookings", "finished.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n },\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afd6d1f8-b50f-4852-923e-85b1cbd3ee64", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings", "finished.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "reminder.json", "description": "", "item": [ { "id": "27e859f2-e472-497c-9556-a39c451fc37e", "name": "Reminder bookings", "request": { "name": "Reminder bookings", "description": { "content": "Returns all bookings starting 24 hours or more from now, ordered by start time descending. Matches the reminder webhook window.", "type": "text/plain" }, "url": { "path": [ "bookings", "reminder.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "70fbd636-fec4-42d8-93e6-345efb9ada46", "name": "successful operation", "originalRequest": { "url": { "path": [ "bookings", "reminder.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n },\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1761bc49-7d5e-4c82-ad0e-4e18e23fd9e9", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings", "reminder.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "one_hour_before.json", "description": "", "item": [ { "id": "070a4178-005f-4b79-8fc1-79bc927c76ce", "name": "One hour before bookings", "request": { "name": "One hour before bookings", "description": { "content": "Returns all bookings starting 1 hour or more from now, ordered by start time descending. Matches the one_hour_before webhook window.", "type": "text/plain" }, "url": { "path": [ "bookings", "one_hour_before.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fbb9a4c1-b7e0-433a-a85f-fb5e14112903", "name": "successful operation", "originalRequest": { "url": { "path": [ "bookings", "one_hour_before.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n },\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef235b45-7368-4698-8fb3-ccdcc1b8afe9", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings", "one_hour_before.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "updated.json", "description": "", "item": [ { "id": "09fd128b-b71f-4e0d-979b-eee966b0a47c", "name": "Updated bookings", "request": { "name": "Updated bookings", "description": { "content": "Returns all non-cancelled bookings, ordered by last updated date descending. Useful for polling for recently changed bookings.", "type": "text/plain" }, "url": { "path": [ "bookings", "updated.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "70cc7e6e-91a3-490a-9211-f617f15fcda3", "name": "successful operation", "originalRequest": { "url": { "path": [ "bookings", "updated.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n },\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ed7f089-72f0-4b8c-a144-dabfa3082d13", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings", "updated.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{code}", "description": "", "item": [ { "name": "transactions.json", "description": "", "item": [ { "id": "e9a9d09d-8918-4061-964e-d3d42d4bd80e", "name": "List booking transactions", "request": { "name": "List booking transactions", "description": { "content": "Returns all money log transactions for the specified booking, ordered by most recent first.\n\nThis includes payments, refunds, credit notes, and other financial transactions\nassociated with the booking.\n", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "transactions.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "90ac0c0d-a516-42af-abfe-35836fbb3c22", "name": "successful operation", "originalRequest": { "url": { "path": [ "bookings", ":code", "transactions.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"source\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"created_at\": \"\",\n \"display_amount\": \"\",\n \"refund\": \"\",\n \"success\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"manual_type\": \"\"\n },\n {\n \"id\": \"\",\n \"source\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"created_at\": \"\",\n \"display_amount\": \"\",\n \"refund\": \"\",\n \"success\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"manual_type\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa88518d-ae83-4d69-a451-79414b17fb89", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings", ":code", "transactions.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "16028df9-f985-4f22-baec-87ca106d0c0e", "name": "Not found - Booking was not found", "originalRequest": { "url": { "path": [ "bookings", ":code", "transactions.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f26555e-7d1e-4ca5-ad18-c1304bf301cc", "name": "Create a transaction for a booking", "request": { "name": "Create a transaction for a booking", "description": { "content": "Create a new transaction (money log entry) for the specified booking.\n\nThis creates a credit note transaction with the specified amount and description.\nThe transaction will be associated with the booking and its customer.\n\nAll amounts should be provided as positive integers in the smallest currency unit\n(cents/pence) - e.g., £10.50 should be provided as 1050.\n", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "transactions.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"manual_type\": \"card\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "86f6fd30-58fc-4805-9bf6-f1b2d44dcefd", "name": "Transaction created successfully", "originalRequest": { "url": { "path": [ "bookings", ":code", "transactions.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"manual_type\": \"card\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"source\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"created_at\": \"\",\n \"display_amount\": \"\",\n \"refund\": \"\",\n \"success\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"manual_type\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "373f27fb-de51-4144-ac37-d3577b1e3d01", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings", ":code", "transactions.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"manual_type\": \"card\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8634daf5-9b1f-4779-b005-333ad13e3853", "name": "Not found - Booking was not found", "originalRequest": { "url": { "path": [ "bookings", ":code", "transactions.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"manual_type\": \"card\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "028e8126-79eb-4788-adca-209906338f91", "name": "Unprocessable - the transaction parameters you provided are invalid", "originalRequest": { "url": { "path": [ "bookings", ":code", "transactions.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transaction\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"manual_type\": \"card\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "studio_notes.json", "description": "", "item": [ { "id": "af21c53e-0af6-41bb-992d-1b9374f5c3fc", "name": "Get booking studio notes", "request": { "name": "Get booking studio notes", "description": { "content": "Returns the studio notes for the specified booking.\n\nStudio notes are internal notes that studios can add to bookings for their own reference.\nThese are not visible to customers.\n", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "studio_notes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f2ee958f-e509-4281-9047-f633c0a5a0c6", "name": "successful operation", "originalRequest": { "url": { "path": [ "bookings", ":code", "studio_notes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"studio_notes\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4d23ce7-c166-45f9-863f-97282db7a208", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings", ":code", "studio_notes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7fb09708-a76f-46b1-85e6-8c99057cf136", "name": "Not found - Booking was not found", "originalRequest": { "url": { "path": [ "bookings", ":code", "studio_notes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb58a0d1-f2fe-4f9c-9f94-7e03ffb6a633", "name": "Update booking studio notes", "request": { "name": "Update booking studio notes", "description": { "content": "Update the studio notes for the specified booking.\n\nStudio notes are internal notes that studios can add to bookings for their own reference.\nThese are not visible to customers.\n", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "studio_notes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"studio_notes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0b459128-a338-4d72-8541-73dd8735dd1d", "name": "Studio notes updated successfully", "originalRequest": { "url": { "path": [ "bookings", ":code", "studio_notes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"studio_notes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"studio_notes\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eef8a986-627f-4dc8-9bf2-68b291b6273b", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings", ":code", "studio_notes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"studio_notes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "888f37de-ffca-4ba1-8d11-666271fbf72a", "name": "Not found - Booking was not found", "originalRequest": { "url": { "path": [ "bookings", ":code", "studio_notes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"studio_notes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "90a77c97-ce13-43f2-a429-2e5dfb9b1ffa", "name": "Cancel a booking", "request": { "name": "Cancel a booking", "description": { "content": "Soft-deletes (cancels) a booking. Optionally sends cancellation email.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "send_email", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "3697e545-be08-4c1f-b774-010150171916", "name": "Booking cancelled", "originalRequest": { "url": { "path": [ "bookings", ":code" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "send_email", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29a36f91-2ccd-4d2d-a504-7315a5ad9eb9", "name": "Booking not found", "originalRequest": { "url": { "path": [ "bookings", ":code" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "send_email", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "uncancel", "description": "", "item": [ { "id": "3cad298b-4f57-4261-b3c5-f7cef8d90824", "name": "Uncancel a booking", "request": { "name": "Uncancel a booking", "description": { "content": "Restores a previously cancelled booking.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "uncancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {}, "auth": null }, "response": [ { "id": "2170b0a0-795e-45fc-95dd-fa6128d6e759", "name": "Booking restored", "originalRequest": { "url": { "path": [ "bookings", ":code", "uncancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "358481e9-3b9b-40a6-97a7-10a3f058ec42", "name": "Booking not found", "originalRequest": { "url": { "path": [ "bookings", ":code", "uncancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "approve", "description": "", "item": [ { "id": "e0d36cb5-ff7d-49c8-88a4-8659a8520404", "name": "Approve a booking", "request": { "name": "Approve a booking", "description": { "content": "Approve a booking that is awaiting approval.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "f1a0a9c3-370b-4fb2-b2de-e4a3ee1b5416", "name": "Booking approved", "originalRequest": { "url": { "path": [ "bookings", ":code", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "reject", "description": "", "item": [ { "id": "b22cea00-da32-4f38-b5fb-a45cb5fb78dd", "name": "Reject a booking", "request": { "name": "Reject a booking", "description": { "content": "Reject a booking that is awaiting approval.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "reject" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "made_by_user_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "e816b2ef-e327-4163-97f9-8deec92eeb9a", "name": "Booking rejected", "originalRequest": { "url": { "path": [ "bookings", ":code", "reject" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "made_by_user_id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "pdf", "description": "", "item": [ { "id": "914ddce9-3d58-47ce-aa52-cc5ccd7ec534", "name": "Generate booking PDF", "request": { "name": "Generate booking PDF", "description": { "content": "Generate a receipt/confirmation PDF for the booking.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ff0c740d-f6a3-4a4c-959b-f66fc722bf2f", "name": "PDF file", "originalRequest": { "url": { "path": [ "bookings", ":code", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/pdf" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "resend_confirmation", "description": "", "item": [ { "id": "b38375d9-f2ac-44db-aea9-2748b3f5f709", "name": "Resend confirmation email", "request": { "name": "Resend confirmation email", "description": { "content": "Re-send the booking confirmation email to the customer.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "resend_confirmation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "82251b8d-34a9-41a4-bd0a-b47f6dd29a07", "name": "Email sent", "originalRequest": { "url": { "path": [ "bookings", ":code", "resend_confirmation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "refund_transaction", "description": "", "item": [ { "id": "596f6b69-bb95-4621-8f30-d1f440f56a1b", "name": "Refund a transaction", "request": { "name": "Refund a transaction", "description": { "content": "Refund a specific payment transaction on a booking (Stripe, Square, or Jammed Pay).", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "refund_transaction" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "transaction_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "7fab5b85-00f0-4f61-abcb-1022d58e17f9", "name": "Transaction refunded", "originalRequest": { "url": { "path": [ "bookings", ":code", "refund_transaction" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "transaction_id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "refunds", "description": "", "item": [ { "id": "3599aec1-bd7b-4b8e-bb74-c43bc296e9f4", "name": "Full refund", "request": { "name": "Full refund", "description": { "content": "Cancel and refund all payments on a booking.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"send_email\": \"\",\n \"refund_reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c2d0f923-07a9-4e72-8251-a2696bdd2737", "name": "Booking refunded", "originalRequest": { "url": { "path": [ "bookings", ":code", "refunds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"send_email\": \"\",\n \"refund_reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "credit_payments", "description": "", "item": [ { "id": "49691648-2e06-41c0-9de6-f72fada5c3a1", "name": "Apply credit balance", "request": { "name": "Apply credit balance", "description": { "content": "Pay a booking using the customer's credit balance.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "credit_payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "e191c310-6c6b-4074-88ec-071748317998", "name": "Credit applied", "originalRequest": { "url": { "path": [ "bookings", ":code", "credit_payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "credit_balances", "description": "", "item": [ { "id": "3f94e483-c636-419a-a2f5-817aaa5eefeb", "name": "Credit to customer balance", "request": { "name": "Credit to customer balance", "description": { "content": "Credit the booking amount to the customer's balance.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "credit_balances" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"credit_amount\": \"\",\n \"send_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fc032f08-1b81-4c42-97ff-3c53989f02a2", "name": "Booking credited", "originalRequest": { "url": { "path": [ "bookings", ":code", "credit_balances" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"credit_amount\": \"\",\n \"send_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "notes", "description": "", "item": [ { "id": "eacc3f48-7122-475c-9863-e81cc7fbd7b4", "name": "Update booking notes", "request": { "name": "Update booking notes", "description": { "content": "Update internal staff notes and colour override for a booking.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"studio_notes\": \"\",\n \"block_colour_override\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ad72da87-eba9-4c3f-b2d1-d2bb63196fc0", "name": "Notes updated", "originalRequest": { "url": { "path": [ "bookings", ":code", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"booking\": {\n \"studio_notes\": \"\",\n \"block_colour_override\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "notifications", "description": "", "item": [ { "id": "a29d9bd8-c217-433d-8b24-98cb6cee72b8", "name": "Booking notifications", "request": { "name": "Booking notifications", "description": { "content": "View notification history for a booking.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "02822001-923a-4412-8a69-62fe543986af", "name": "Notifications list", "originalRequest": { "url": { "path": [ "bookings", ":code", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "history.json", "description": "", "item": [ { "id": "2f425131-fb74-4946-bc65-8ba99918ece5", "name": "Booking history", "request": { "name": "Booking history", "description": { "content": "Returns a chronological timeline of all activity on a booking,\nsorted ascending by time. Includes transactions, notifications,\nstatus changes, price changes, coupon redemptions, and more.\n", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "history.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d9b41ceb-df8c-43ee-be03-29a9268753a8", "name": "History timeline", "originalRequest": { "url": { "path": [ "bookings", ":code", "history.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"title\": \"\",\n \"timestamp\": \"\",\n \"description\": \"\"\n },\n {\n \"title\": \"\",\n \"timestamp\": \"\",\n \"description\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf8e6481-6fa9-4d4d-90a8-79f7a125d81a", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "bookings", ":code", "history.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c8196ed-d72f-43ae-9c55-b30ad711e741", "name": "Not found - Booking was not found", "originalRequest": { "url": { "path": [ "bookings", ":code", "history.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "payment_requests", "description": "", "item": [ { "id": "23311708-37e4-46f4-bc8f-14fdef8aaf21", "name": "Send payment request", "request": { "name": "Send payment request", "description": { "content": "Create and send a payment link to the customer.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "payment_requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"price\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "97c033de-dbde-4483-a5d1-7ccdb5ee970f", "name": "Payment request sent", "originalRequest": { "url": { "path": [ "bookings", ":code", "payment_requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"price\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "charge", "description": "", "item": [ { "id": "764eb77a-8f1c-44a7-9a86-8e58b46db918", "name": "Charge saved card", "request": { "name": "Charge saved card", "description": { "content": "Create a payment request and immediately charge the customer's saved card. This is a collection action — it creates a new payment request and settles it in one step.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "payment_requests", "charge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"price\": \"\",\n \"use_payment_method\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "add14aa2-e541-4a91-9d56-3e7702e2d6f1", "name": "Payment taken", "originalRequest": { "url": { "path": [ "bookings", ":code", "payment_requests", "charge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"price\": \"\",\n \"use_payment_method\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{id}", "description": "", "item": [ { "name": "mark_as_paid", "description": "", "item": [ { "id": "414af52e-ce9f-4a2a-b071-3c296f22f7ee", "name": "Mark payment as paid", "request": { "name": "Mark payment as paid", "description": { "content": "Record that a manual payment has been received.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "payment_requests", ":id", "mark_as_paid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } }, { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "cd80d957-6e48-469e-909a-2d0c390f4050", "name": "Marked as paid", "originalRequest": { "url": { "path": [ "bookings", ":code", "payment_requests", ":id", "mark_as_paid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "cancel", "description": "", "item": [ { "id": "bb4bf59a-ad7d-4c9f-b21c-0342f4725abf", "name": "Cancel payment request", "request": { "name": "Cancel payment request", "description": { "content": "Cancel an open payment request.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "payment_requests", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } }, { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "72b036e6-b4d5-4ec3-9f55-ba4d1c94e959", "name": "Payment request cancelled", "originalRequest": { "url": { "path": [ "bookings", ":code", "payment_requests", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "settlement_supported", "description": "", "item": [ { "id": "3f2bdc63-cf68-41dd-ae42-16a2961e114b", "name": "Check settlement support", "request": { "name": "Check settlement support", "description": { "content": "Check if the booking's customer can be charged remotely (has saved payment methods).", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "settlement_supported" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1db4bb35-5596-4411-b5da-1e469ff5d237", "name": "Settlement check result", "originalRequest": { "url": { "path": [ "bookings", ":code", "settlement_supported" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"settlement_supported\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "credit_notes", "description": "", "item": [ { "id": "ec4d59aa-d4e9-486f-8d41-33f8d6a26560", "name": "Create credit note", "request": { "name": "Create credit note", "description": { "content": "Apply a manual credit note to a booking (cash, card, or other payment).", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "credit_notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"price\": \"\",\n \"description\": \"\",\n \"manual_type\": \"card\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "908a18fb-e4e6-4e0c-94b1-dfe3e6ba3181", "name": "Credit note created", "originalRequest": { "url": { "path": [ "bookings", ":code", "credit_notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"price\": \"\",\n \"description\": \"\",\n \"manual_type\": \"card\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "75b66ebe-7376-4a0b-9bc2-d710c4207203", "name": "Delete credit note", "request": { "name": "Delete credit note", "description": { "content": "Remove a credit note from a booking.", "type": "text/plain" }, "url": { "path": [ "bookings", ":code", "credit_notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "code", "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" } }, { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Credit note (MoneyLog) ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "2e9f1644-b5bf-479a-83b5-af2a8f4446a5", "name": "Credit note removed", "originalRequest": { "url": { "path": [ "bookings", ":code", "credit_notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) Credit note (MoneyLog) ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64ac3f5f-5f59-41e4-9c11-2559e136d754", "name": "Credit note or booking not found", "originalRequest": { "url": { "path": [ "bookings", ":code", "credit_notes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Booking code", "type": "text/plain" }, "type": "any", "value": "", "key": "code" }, { "disabled": false, "description": { "content": "(Required) Credit note (MoneyLog) ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "search", "description": "", "item": [ { "id": "0b7292a9-d78f-4a39-9664-73c2811ad73e", "name": "Search bookings", "request": { "name": "Search bookings", "description": { "content": "Search bookings by customer name, email, mobile, band name, or booking code. Supports status filtering.", "type": "text/plain" }, "url": { "path": [ "bookings", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search query", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by booking status (This can only be one of active,cancelled,cancelled_and_active)", "type": "text/plain" }, "key": "status_filter", "value": "active" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f7fdd5ba-820c-480d-bd08-daca5577f732", "name": "Search results", "originalRequest": { "url": { "path": [ "bookings", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search query", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by booking status (This can only be one of active,cancelled,cancelled_and_active)", "type": "text/plain" }, "key": "status_filter", "value": "active" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n },\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "by_dates", "description": "", "item": [ { "id": "72f7e610-0723-4d90-96bd-0dfa9f8d4638", "name": "Bookings by date range", "request": { "name": "Bookings by date range", "description": { "content": "Returns bookings for a date range, optimized for calendar/schedule display.", "type": "text/plain" }, "url": { "path": [ "bookings", "by_dates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2824a7f3-be80-4539-964a-950f20983a89", "name": "Bookings for date range", "originalRequest": { "url": { "path": [ "bookings", "by_dates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"band_name\": \"\",\n \"is_recording\": \"\",\n \"session_name\": \"\",\n \"block_colour_override\": \"\",\n \"studio_notes\": \"\",\n \"additional_notes\": \"\",\n \"number_expected\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"split\": \"\",\n \"room_name\": \"\",\n \"has_amount_due\": \"\",\n \"amount_due\": \"\",\n \"payments_recieved\": \"\",\n \"regular\": \"\",\n \"incomplete\": \"\",\n \"show_studio_notes\": \"\",\n \"extras_summary\": [\n \"\",\n \"\"\n ],\n \"link\": \"\",\n \"type\": \"\",\n \"class\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"band_name\": \"\",\n \"is_recording\": \"\",\n \"session_name\": \"\",\n \"block_colour_override\": \"\",\n \"studio_notes\": \"\",\n \"additional_notes\": \"\",\n \"number_expected\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"split\": \"\",\n \"room_name\": \"\",\n \"has_amount_due\": \"\",\n \"amount_due\": \"\",\n \"payments_recieved\": \"\",\n \"regular\": \"\",\n \"incomplete\": \"\",\n \"show_studio_notes\": \"\",\n \"extras_summary\": [\n \"\",\n \"\"\n ],\n \"link\": \"\",\n \"type\": \"\",\n \"class\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "awaiting_approval", "description": "", "item": [ { "id": "e2607442-f519-4dd2-b930-87554838e2cf", "name": "Bookings awaiting approval", "request": { "name": "Bookings awaiting approval", "description": { "content": "List bookings pending manager approval.", "type": "text/plain" }, "url": { "path": [ "bookings", "awaiting_approval" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "aa519837-e7fc-43d8-82bb-b672ddf6c656", "name": "Pending bookings", "originalRequest": { "url": { "path": [ "bookings", "awaiting_approval" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n },\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "customers.json", "description": "", "item": [ { "id": "f0073496-0830-496f-abab-7f2790058fca", "name": "Find all customers", "request": { "name": "Find all customers", "description": { "content": "Returns all customers", "type": "text/plain" }, "url": { "path": [ "customers.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e6d53f1e-d04f-482a-a222-5bae69bdc9c5", "name": "successful operation", "originalRequest": { "url": { "path": [ "customers.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"avatar\": \"\",\n \"credit_balance\": \"\",\n \"status\": \"unregistered\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\",\n \"signed_up\": \"\",\n \"signed_up_at\": \"\",\n \"regular_bookings_count\": \"\",\n \"bookings_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_booking_at\": \"\",\n \"regular_bookings\": [\n {\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"bands\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n }\n ],\n \"address\": {\n \"company\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"town\": \"\",\n \"state\": \"\",\n \"postcode\": \"\",\n \"country\": \"\",\n \"formatted_address\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"avatar\": \"\",\n \"credit_balance\": \"\",\n \"status\": \"registered\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\",\n \"signed_up\": \"\",\n \"signed_up_at\": \"\",\n \"regular_bookings_count\": \"\",\n \"bookings_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_booking_at\": \"\",\n \"regular_bookings\": [\n {\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"bands\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n }\n ],\n \"address\": {\n \"company\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"town\": \"\",\n \"state\": \"\",\n \"postcode\": \"\",\n \"country\": \"\",\n \"formatted_address\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "916cde37-b6b5-48f7-bbd1-e16625b76011", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "customers.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "59e4686c-6b07-413e-8dc8-bde8e9fe490e", "name": "Create a customer", "request": { "name": "Create a customer", "description": { "content": "Create a new customer on Jammed.\n\nWith a new customer, you must at least provide an **name** and **email address**.\n\nYou can also issue `actions` to the endpoint, to create and invite the customer to set a password - Jammed will then send them an email from your account with a link to set their password.\n\nYou can't create a customer with an email address that already exists as a registered customer on Jammed. You can create a customer with an email address that already exists, so long as the customer is not yet registered on Jammed.\n\n**Jammed API doesn't accept passwords for customer creation process** - they must be set by the customer themselves in the invitation process to verify the email and to improve security.\n", "type": "text/plain" }, "url": { "path": [ "customers.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"actions\": {\n \"invite\": \"\"\n }\n}" }, "auth": null }, "response": [ { "id": "5142adcd-0e56-4731-81a9-b6adc5de5c55", "name": "Customer created", "originalRequest": { "url": { "path": [ "customers.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"actions\": {\n \"invite\": \"\"\n }\n}" } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"avatar\": \"\",\n \"credit_balance\": \"\",\n \"status\": \"unregistered\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\",\n \"signed_up\": \"\",\n \"signed_up_at\": \"\",\n \"regular_bookings_count\": \"\",\n \"bookings_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_booking_at\": \"\",\n \"regular_bookings\": [\n {\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"bands\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n }\n ],\n \"address\": {\n \"company\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"town\": \"\",\n \"state\": \"\",\n \"postcode\": \"\",\n \"country\": \"\",\n \"formatted_address\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"avatar\": \"\",\n \"credit_balance\": \"\",\n \"status\": \"registered\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\",\n \"signed_up\": \"\",\n \"signed_up_at\": \"\",\n \"regular_bookings_count\": \"\",\n \"bookings_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_booking_at\": \"\",\n \"regular_bookings\": [\n {\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"bands\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n }\n ],\n \"address\": {\n \"company\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"town\": \"\",\n \"state\": \"\",\n \"postcode\": \"\",\n \"country\": \"\",\n \"formatted_address\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0f7e714-f55b-43b8-b35f-5ff817fa86b7", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "customers.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "form-data" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"actions\": {\n \"invite\": \"\"\n }\n}" } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0241157d-74f9-4b99-96b5-fa5bb656f173", "name": "Unprocessable - the customer parameters you provided are invalid", "originalRequest": { "url": { "path": [ "customers.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"actions\": {\n \"invite\": \"\"\n }\n}" } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "customers", "description": "", "item": [ { "name": "{id}.json", "description": "", "item": [ { "id": "4d929f41-07e3-4848-8eb6-55b24c790d86", "name": "Find a customer by ID", "request": { "name": "Find a customer by ID", "description": { "content": "Returns customer with the given ID", "type": "text/plain" }, "url": { "path": [ "customers", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bebaa029-c258-44d0-b645-0c83897eb42b", "name": "successful operation", "originalRequest": { "url": { "path": [ "customers", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"avatar\": \"\",\n \"credit_balance\": \"\",\n \"status\": \"banned\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\",\n \"signed_up\": \"\",\n \"signed_up_at\": \"\",\n \"regular_bookings_count\": \"\",\n \"bookings_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_booking_at\": \"\",\n \"regular_bookings\": [\n {\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"bands\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n }\n ],\n \"address\": {\n \"company\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"town\": \"\",\n \"state\": \"\",\n \"postcode\": \"\",\n \"country\": \"\",\n \"formatted_address\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52e942f1-fd82-4124-9446-61a228e6203a", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "customers", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c5219e3d-9b7e-4f6e-a92c-0f1ac90d7fac", "name": "Not found - Customer was not found", "originalRequest": { "url": { "path": [ "customers", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{id}", "description": "", "item": [ { "id": "413adf25-ebae-492b-af53-aedba7d30779", "name": "Update customer", "request": { "name": "Update customer", "description": { "content": "Update an existing customer's details.", "type": "text/plain" }, "url": { "path": [ "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5a35e4f3-7776-4a67-9386-72496fd4215b", "name": "Customer updated", "originalRequest": { "url": { "path": [ "customers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"avatar\": \"\",\n \"credit_balance\": \"\",\n \"status\": \"banned\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\",\n \"signed_up\": \"\",\n \"signed_up_at\": \"\",\n \"regular_bookings_count\": \"\",\n \"bookings_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_booking_at\": \"\",\n \"regular_bookings\": [\n {\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"bands\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n }\n ],\n \"address\": {\n \"company\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"town\": \"\",\n \"state\": \"\",\n \"postcode\": \"\",\n \"country\": \"\",\n \"formatted_address\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "notes", "description": "", "item": [ { "id": "bf89b1a2-79f7-4aae-b409-2e7c43ffd8c9", "name": "Update customer notes", "request": { "name": "Update customer notes", "description": { "content": "Add or update internal staff notes about a customer.", "type": "text/plain" }, "url": { "path": [ "customers", ":id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"notes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "121929bf-ed34-40e4-a25c-5935030b8ed5", "name": "Notes updated", "originalRequest": { "url": { "path": [ "customers", ":id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"notes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"avatar\": \"\",\n \"credit_balance\": \"\",\n \"status\": \"banned\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\",\n \"signed_up\": \"\",\n \"signed_up_at\": \"\",\n \"regular_bookings_count\": \"\",\n \"bookings_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_booking_at\": \"\",\n \"regular_bookings\": [\n {\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"bands\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n }\n ],\n \"address\": {\n \"company\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"town\": \"\",\n \"state\": \"\",\n \"postcode\": \"\",\n \"country\": \"\",\n \"formatted_address\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "invite", "description": "", "item": [ { "id": "cbfb9021-abf4-49ef-8bcd-e5aee8930fdc", "name": "Invite an existing customer", "request": { "name": "Invite an existing customer", "description": { "content": "Send a registration invitation to an existing customer who has not yet created their account.\n\nJammed emails the customer a link to set their password, exactly as if they had been created with the `invite` action on `POST /customers.json` - but without creating a duplicate customer record. Use this when the customer already exists (for example, they've already made a booking) and you want them to register.\n\nOn success, the customer's `status` becomes `invited`. The invitation link is valid for 2 days - after it expires, calling this endpoint again issues a fresh invitation.\n\nReturns a `422` error if the customer has already registered an account, or if they already have a valid (unexpired) invitation. Returns a `404` if the customer does not exist or has been deleted.\n", "type": "text/plain" }, "url": { "path": [ "customers", ":id", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "5fb52366-5a30-46b4-ad39-3b319faad1a1", "name": "Invitation sent", "originalRequest": { "url": { "path": [ "customers", ":id", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"avatar\": \"\",\n \"credit_balance\": \"\",\n \"status\": \"banned\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\",\n \"signed_up\": \"\",\n \"signed_up_at\": \"\",\n \"regular_bookings_count\": \"\",\n \"bookings_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_booking_at\": \"\",\n \"regular_bookings\": [\n {\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"id\": \"\"\n }\n ],\n \"bands\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n }\n ],\n \"address\": {\n \"company\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"town\": \"\",\n \"state\": \"\",\n \"postcode\": \"\",\n \"country\": \"\",\n \"formatted_address\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef3f877e-c095-44cb-9d79-795134a3572c", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "customers", ":id", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bf8080ea-e904-4b33-b92f-57b7ff112675", "name": "Not found - Customer was not found", "originalRequest": { "url": { "path": [ "customers", ":id", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f717b297-06e6-4932-8175-2dcf7a355d03", "name": "Unprocessable - the customer has already registered, or already has a valid invite", "originalRequest": { "url": { "path": [ "customers", ":id", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "bookings", "description": "", "item": [ { "id": "1a7516dc-3700-4091-a9ec-50aa84bd95c1", "name": "Customer bookings", "request": { "name": "Customer bookings", "description": { "content": "List a customer's completed, non-cancelled bookings.", "type": "text/plain" }, "url": { "path": [ "customers", ":id", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a261f9a9-3d13-4bed-8f45-997e7df97c28", "name": "Customer's bookings", "originalRequest": { "url": { "path": [ "customers", ":id", "bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n },\n {\n \"group\": {\n \"name\": \"\",\n \"code\": \"\",\n \"number_of_members\": \"\",\n \"number\": \"\",\n \"booking_count\": \"\"\n },\n \"customer\": {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n \"room\": {\n \"name\": \"\",\n \"code\": \"\"\n },\n \"extras\": [\n {\n \"name\": \"\",\n \"category\": \"\"\n },\n {\n \"name\": \"\",\n \"category\": \"\"\n }\n ],\n \"custom_answers\": [\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n },\n {\n \"question_id\": \"\",\n \"name\": \"\",\n \"response\": \"\"\n }\n ],\n \"source_data\": {\n \"source\": \"\",\n \"platform\": \"\",\n \"referrer\": \"\"\n },\n \"code\": \"\",\n \"id\": \"\",\n \"recording\": \"\",\n \"regular\": \"\",\n \"online_booking\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"approved_at\": \"\",\n \"rejected_at\": \"\",\n \"price\": \"\",\n \"price_currency\": \"\",\n \"title\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"duration\": \"\",\n \"duration_hours\": \"\",\n \"duration_full_hours\": \"\",\n \"activity_name\": \"\",\n \"dates\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"\",\n \"has_amount_due\": \"\",\n \"remaining_amount\": \"\",\n \"cancelled\": \"\",\n \"taken_by\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "credit_balance", "description": "", "item": [ { "id": "e25e58f7-3b05-4377-8596-5783d79146a9", "name": "Get credit balance", "request": { "name": "Get credit balance", "description": { "content": "View the customer's current credit balance.", "type": "text/plain" }, "url": { "path": [ "customers", ":id", "credit_balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9d39be1e-115d-4f49-ad86-ade4ac5201e9", "name": "Credit balance", "originalRequest": { "url": { "path": [ "customers", ":id", "credit_balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"credit_balance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c60316db-e467-4542-9356-dbc4efa85415", "name": "Update credit balance", "request": { "name": "Update credit balance", "description": { "content": "Adjust the customer's credit balance. Creates a credit movement record.", "type": "text/plain" }, "url": { "path": [ "customers", ":id", "credit_balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"credit_balance\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c1b423fd-7df7-4a3f-b60d-779e9d0e6e00", "name": "Balance updated", "originalRequest": { "url": { "path": [ "customers", ":id", "credit_balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"credit_balance\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"credit_balance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "credit_movements", "description": "", "item": [ { "id": "e7cd3c57-7580-42d0-982b-3f3c4c56d11b", "name": "Credit movements", "request": { "name": "Credit movements", "description": { "content": "View credit transaction history for a customer.", "type": "text/plain" }, "url": { "path": [ "customers", ":id", "credit_movements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a6219ee9-4dc1-4f7b-9689-ed8271a46fe5", "name": "Credit movements", "originalRequest": { "url": { "path": [ "customers", ":id", "credit_movements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"source\": \"\",\n \"created_at\": \"\",\n \"booking\": {\n \"id\": \"\",\n \"code\": \"\"\n },\n \"made_by\": \"\"\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"source\": \"\",\n \"created_at\": \"\",\n \"booking\": {\n \"id\": \"\",\n \"code\": \"\"\n },\n \"made_by\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "status", "description": "", "item": [ { "id": "9feeb94d-c9a2-45f0-8a53-abcb20bb3c9e", "name": "Customer status", "request": { "name": "Customer status", "description": { "content": "Check if a customer is banned or behind on payment.", "type": "text/plain" }, "url": { "path": [ "customers", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c32d130d-834d-4492-b7ee-fdf417a186d4", "name": "Customer status", "originalRequest": { "url": { "path": [ "customers", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"\",\n \"banned\": \"\",\n \"behind_payment\": \"\",\n \"status_reason_text\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "payment_methods", "description": "", "item": [ { "id": "3503a827-6e34-4db9-80c1-bf1470dcefcd", "name": "Payment methods", "request": { "name": "Payment methods", "description": { "content": "List a customer's saved payment methods (for remote charging).", "type": "text/plain" }, "url": { "path": [ "customers", ":id", "payment_methods" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "50e52cbb-5171-4128-acae-377a8d461bca", "name": "Payment methods", "originalRequest": { "url": { "path": [ "customers", ":id", "payment_methods" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "search", "description": "", "item": [ { "id": "af72f388-6adc-4ef8-9a86-346c84bff29e", "name": "Search customers", "request": { "name": "Search customers", "description": { "content": "Autocomplete search by name, email, mobile, or band name. Returns top 10 results by booking count.", "type": "text/plain" }, "url": { "path": [ "customers", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search query (min 1 character)", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "42fbf71c-74ac-4524-a1b1-a7904ab7d7ec", "name": "Matching customers", "originalRequest": { "url": { "path": [ "customers", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search query (min 1 character)", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "coupons", "description": "", "item": [ { "name": "{id}.json", "description": "", "item": [ { "id": "8dff4cb5-6398-491c-8b44-cc065bfa884d", "name": "Find a coupon by ID", "request": { "name": "Find a coupon by ID", "description": { "content": "Returns coupon with the given ID", "type": "text/plain" }, "url": { "path": [ "coupons", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "42a930d0-fa54-411b-b9fa-ee5f98916f04", "name": "successful operation", "originalRequest": { "url": { "path": [ "coupons", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"discount_type\": \"\",\n \"amount\": \"\",\n \"all_new_customers\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"fully_used\": \"\",\n \"expired\": \"\",\n \"status\": \"\",\n \"duration\": \"\",\n \"total_number_of_uses\": \"\",\n \"number_of_times_used\": \"\",\n \"promocodes\": [\n {\n \"coupon\": {\n \"id\": \"\",\n \"code\": \"\",\n \"minimum_booking_value\": \"\",\n \"first_time_use_only\": \"\"\n }\n },\n {\n \"coupon\": {\n \"id\": \"\",\n \"code\": \"\",\n \"minimum_booking_value\": \"\",\n \"first_time_use_only\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6b04130-6804-4f82-a488-c02a51c6e731", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "coupons", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "518ee063-2840-49bc-86ee-425fb2211ee4", "name": "Not found - Coupon was not found", "originalRequest": { "url": { "path": [ "coupons", "{{id}}.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{coupon_id}", "description": "", "item": [ { "name": "promocodes.json", "description": "", "item": [ { "id": "6a1c1dc7-898d-45df-bc38-746f46d141bf", "name": "Find all promocodes", "request": { "name": "Find all promocodes", "description": { "content": "Returns all promocodes", "type": "text/plain" }, "url": { "path": [ "coupons", ":coupon_id", "promocodes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "coupon_id", "disabled": false, "description": { "content": "(Required) Coupon ID to list the promocodes for", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "64551771-b27a-4ac3-b177-11fb9f4ec1bf", "name": "successful operation", "originalRequest": { "url": { "path": [ "coupons", ":coupon_id", "promocodes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon ID to list the promocodes for", "type": "text/plain" }, "type": "any", "value": "", "key": "coupon_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"code\": \"\",\n \"minimum_booking_value\": \"\",\n \"first_time_use_only\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06f294a9-3bbd-4a3b-8ff0-5ada5f1003ac", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "coupons", ":coupon_id", "promocodes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon ID to list the promocodes for", "type": "text/plain" }, "type": "any", "value": "", "key": "coupon_id" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7962af02-ccf5-4fc7-9a99-4f4598f6355e", "name": "Create a promocode", "request": { "name": "Create a promocode", "description": { "content": "Create a promocode for a coupon\n\nYou can provide the API with a **code**, but if you don't we'll generate one for you.\n\nYou can just `POST` an empty body to create a promocode for a coupon with a generated code.\n\nWith promocodes you can specify minimum booking values, redemptions limits, limit only to one customer, and limit one use per customer.\n\nOnce created, a Promocode can be used to apply the Coupon to a booking via the customer booking form\n", "type": "text/plain" }, "url": { "path": [ "coupons", ":coupon_id", "promocodes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "coupon_id", "disabled": false, "description": { "content": "(Required) Coupon ID to create promocode for", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"promocode\": {\n \"code\": \"\",\n \"minimum_booking_value\": \"\"\n }\n}" }, "auth": null }, "response": [ { "id": "fccdf058-3406-4777-a470-212503d8b4ea", "name": "Promocode created", "originalRequest": { "url": { "path": [ "coupons", ":coupon_id", "promocodes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon ID to create promocode for", "type": "text/plain" }, "type": "any", "value": "", "key": "coupon_id" } ] }, "header": [ { "key": "Content-Type", "value": "form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"promocode\": {\n \"code\": \"\",\n \"minimum_booking_value\": \"\"\n }\n}" } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"code\": \"\",\n \"minimum_booking_value\": \"\",\n \"first_time_use_only\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"minimum_booking_value\": \"\",\n \"first_time_use_only\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b796893-db47-451f-a71e-d9c0474a1db5", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "coupons", ":coupon_id", "promocodes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon ID to create promocode for", "type": "text/plain" }, "type": "any", "value": "", "key": "coupon_id" } ] }, "header": [ { "key": "Content-Type", "value": "form-data" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"promocode\": {\n \"code\": \"\",\n \"minimum_booking_value\": \"\"\n }\n}" } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ae373a0b-a328-4f3c-9eb9-ef80e4df2a61", "name": "Unprocessable - the promocode parameters you provided are invalid", "originalRequest": { "url": { "path": [ "coupons", ":coupon_id", "promocodes.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon ID to create promocode for", "type": "text/plain" }, "type": "any", "value": "", "key": "coupon_id" } ] }, "header": [ { "key": "Content-Type", "value": "form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"promocode\": {\n \"code\": \"\",\n \"minimum_booking_value\": \"\"\n }\n}" } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "assign_to_customer.json", "description": "", "item": [ { "id": "744831d7-cf45-4fb3-bb81-1ed81f221c9d", "name": "Assign Coupon to Customer", "request": { "name": "Assign Coupon to Customer", "description": { "content": "Assign a Coupon to a Customer\n\nUsing the Coupon ID and a Customer ID, we can assign a Coupon to a Customer\n\nThis will mean that the Customer will automatically be able to use the Coupon when booking without the use of a promocode\n", "type": "text/plain" }, "url": { "path": [ "coupons", ":coupon_id", "assign_to_customer.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "coupon_id", "disabled": false, "description": { "content": "(Required) Coupon ID to create promocode for", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\"\n}" }, "auth": null }, "response": [ { "id": "faa33295-fd48-4428-ac9b-0fc73ed67a90", "name": "Promocode assigned", "originalRequest": { "url": { "path": [ "coupons", ":coupon_id", "assign_to_customer.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon ID to create promocode for", "type": "text/plain" }, "type": "any", "value": "", "key": "coupon_id" } ] }, "header": [ { "key": "Content-Type", "value": "form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\"\n}" } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"code\": \"\",\n \"minimum_booking_value\": \"\",\n \"first_time_use_only\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b9bdd7d-ba07-4cc6-8406-95b0375b2bd6", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "coupons", ":coupon_id", "assign_to_customer.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon ID to create promocode for", "type": "text/plain" }, "type": "any", "value": "", "key": "coupon_id" } ] }, "header": [ { "key": "Content-Type", "value": "form-data" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\"\n}" } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "497b9062-067e-4875-a2aa-7303c6b996a1", "name": "Coupon has already been assigned to this Customer", "originalRequest": { "url": { "path": [ "coupons", ":coupon_id", "assign_to_customer.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Coupon ID to create promocode for", "type": "text/plain" }, "type": "any", "value": "", "key": "coupon_id" } ] }, "header": [ { "key": "Content-Type", "value": "form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\"\n}" } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "coupons.json", "description": "", "item": [ { "id": "ee9e2358-eda8-494c-a897-17a44a01f0c8", "name": "Find all coupons", "request": { "name": "Find all coupons", "description": { "content": "Returns all coupons", "type": "text/plain" }, "url": { "path": [ "coupons.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2228916a-07b1-499e-8f69-431328b11bba", "name": "successful operation", "originalRequest": { "url": { "path": [ "coupons.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"discount_type\": \"\",\n \"amount\": \"\",\n \"all_new_customers\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"fully_used\": \"\",\n \"expired\": \"\",\n \"status\": \"\",\n \"duration\": \"\",\n \"total_number_of_uses\": \"\",\n \"number_of_times_used\": \"\",\n \"promocodes\": [\n {\n \"coupon\": {\n \"id\": \"\",\n \"code\": \"\",\n \"minimum_booking_value\": \"\",\n \"first_time_use_only\": \"\"\n }\n },\n {\n \"coupon\": {\n \"id\": \"\",\n \"code\": \"\",\n \"minimum_booking_value\": \"\",\n \"first_time_use_only\": \"\"\n }\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"discount_type\": \"\",\n \"amount\": \"\",\n \"all_new_customers\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"fully_used\": \"\",\n \"expired\": \"\",\n \"status\": \"\",\n \"duration\": \"\",\n \"total_number_of_uses\": \"\",\n \"number_of_times_used\": \"\",\n \"promocodes\": [\n {\n \"coupon\": {\n \"id\": \"\",\n \"code\": \"\",\n \"minimum_booking_value\": \"\",\n \"first_time_use_only\": \"\"\n }\n },\n {\n \"coupon\": {\n \"id\": \"\",\n \"code\": \"\",\n \"minimum_booking_value\": \"\",\n \"first_time_use_only\": \"\"\n }\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68126678-413f-47f9-94f7-de367ee24071", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "coupons.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac891c5b-ced1-4299-b12b-337c65c8fc9d", "name": "Create a coupon", "request": { "name": "Create a coupon", "description": { "content": "Create a new coupon on Jammed.\n\nWith a new coupon, you must at least provide an **name**, **amount** and **discount_type**.\n\n`discount type` is either `fixed_amount`, or `percentage` - and `amount` is in pence/cents or whole pencentage points.\n\nOnce created, a Coupon can be used by staff members only on a booking. To allow customers to use the Coupon, you need to generate Promocode for the Coupon.\n", "type": "text/plain" }, "url": { "path": [ "coupons.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"coupon\": {\n \"name\": \"\",\n \"duration\": \"\",\n \"amount\": \"\",\n \"discount_type\": \"\",\n \"all_new_customers\": \"\",\n \"total_number_of_uses\": \"\",\n \"expires_at\": \"\"\n }\n}" }, "auth": null }, "response": [ { "id": "784b4829-d4b0-4971-9c79-faaef3358d49", "name": "Coupon created", "originalRequest": { "url": { "path": [ "coupons.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"coupon\": {\n \"name\": \"\",\n \"duration\": \"\",\n \"amount\": \"\",\n \"discount_type\": \"\",\n \"all_new_customers\": \"\",\n \"total_number_of_uses\": \"\",\n \"expires_at\": \"\"\n }\n}" } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"discount_type\": \"\",\n \"amount\": \"\",\n \"all_new_customers\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"fully_used\": \"\",\n \"expired\": \"\",\n \"status\": \"\",\n \"duration\": \"\",\n \"total_number_of_uses\": \"\",\n \"number_of_times_used\": \"\",\n \"promocodes\": [\n {\n \"coupon\": {\n \"id\": \"\",\n \"code\": \"\",\n \"minimum_booking_value\": \"\",\n \"first_time_use_only\": \"\"\n }\n },\n {\n \"coupon\": {\n \"id\": \"\",\n \"code\": \"\",\n \"minimum_booking_value\": \"\",\n \"first_time_use_only\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86a57d37-855f-4c6c-8d23-843eb92e13da", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "coupons.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "form-data" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"coupon\": {\n \"name\": \"\",\n \"duration\": \"\",\n \"amount\": \"\",\n \"discount_type\": \"\",\n \"all_new_customers\": \"\",\n \"total_number_of_uses\": \"\",\n \"expires_at\": \"\"\n }\n}" } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce0d00ba-799a-45e4-9ae3-c5ff08010144", "name": "Unprocessable - the coupon parameters you provided are invalid", "originalRequest": { "url": { "path": [ "coupons.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"coupon\": {\n \"name\": \"\",\n \"duration\": \"\",\n \"amount\": \"\",\n \"discount_type\": \"\",\n \"all_new_customers\": \"\",\n \"total_number_of_uses\": \"\",\n \"expires_at\": \"\"\n }\n}" } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "groups.json", "description": "", "item": [ { "id": "2805cdfa-9a87-4339-bd2c-dc04a44dcbdc", "name": "Find all groups", "request": { "name": "Find all groups", "description": { "content": "Returns all groups", "type": "text/plain" }, "url": { "path": [ "groups.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f3d65243-b45a-4eb6-8295-9f86b0016eac", "name": "successful operation", "originalRequest": { "url": { "path": [ "groups.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"name\": \"\",\n \"group_type\": \"\",\n \"number_of_members\": \"\",\n \"customer_count\": \"\",\n \"regular_bookings_count\": \"\",\n \"bookings_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_booking_at\": \"\",\n \"customers\": [\n {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n }\n ],\n \"regular_bookings\": [\n {\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"id\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"group_type\": \"\",\n \"number_of_members\": \"\",\n \"customer_count\": \"\",\n \"regular_bookings_count\": \"\",\n \"bookings_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"last_booking_at\": \"\",\n \"customers\": [\n {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n },\n {\n \"name\": \"string\",\n \"email\": \"string\",\n \"id\": \"\",\n \"mobile\": \"string\",\n \"avatar\": \"string\",\n \"reminders_opt_in\": \"\",\n \"mailing_list_opt_in\": \"\"\n }\n ],\n \"regular_bookings\": [\n {\n \"name\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"id\": \"\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4683d455-9b4f-4413-a060-bb34e0757011", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "groups.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "rooms.json", "description": "", "item": [ { "id": "a53a635a-64d5-4b26-8c15-77866ed3a2cc", "name": "Find all rooms", "request": { "name": "Find all rooms", "description": { "content": "Returns all rooms", "type": "text/plain" }, "url": { "path": [ "rooms.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "63953336-888a-4fdf-a29a-c5c32f8bcf2f", "name": "successful operation", "originalRequest": { "url": { "path": [ "rooms.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"space_for\": \"\",\n \"order\": \"\",\n \"twenty_four_hour_booking\": \"\",\n \"space_type\": \"\",\n \"hex_colour\": \"\",\n \"active\": \"\",\n \"prices_set\": \"\",\n \"price_to\": \"\",\n \"price_from\": \"\",\n \"images\": [\n {\n \"original\": \"\"\n },\n {\n \"original\": \"\"\n }\n ],\n \"data\": {}\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"space_for\": \"\",\n \"order\": \"\",\n \"twenty_four_hour_booking\": \"\",\n \"space_type\": \"\",\n \"hex_colour\": \"\",\n \"active\": \"\",\n \"prices_set\": \"\",\n \"price_to\": \"\",\n \"price_from\": \"\",\n \"images\": [\n {\n \"original\": \"\"\n },\n {\n \"original\": \"\"\n }\n ],\n \"data\": {}\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7033eca9-9603-4ffe-9381-c96ab0d9d589", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "rooms.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "studio.json", "description": "", "item": [ { "id": "3584887a-8087-455e-98d2-2ff22d213549", "name": "Studio configuration", "request": { "name": "Studio configuration", "description": { "content": "Returns studio branding, feature toggles, usage flags, payment setup, wordings, and plan info.\nDesigned to be called on app launch and cached client-side (recommended: 1 hour).\n", "type": "text/plain" }, "url": { "path": [ "studio.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dc02aa3c-720e-41a1-bb68-f19c9a2d78c6", "name": "Studio configuration", "originalRequest": { "url": { "path": [ "studio.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"studio\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"url\": \"\",\n \"logo\": {\n \"default\": \"\",\n \"square\": \"\",\n \"app\": \"\"\n },\n \"timezone\": \"\",\n \"currency_code\": \"\",\n \"currency_symbol\": \"\",\n \"country_code\": \"\",\n \"opening_time\": \"\",\n \"closing_time\": \"\",\n \"slot_length\": \"\",\n \"tax_rate\": \"\",\n \"rooms_count\": \"\"\n },\n \"features\": {\n \"bands_and_groups\": \"\",\n \"bookable_staff\": \"\",\n \"approval_required\": \"\",\n \"enquiries\": \"\",\n \"memberships\": \"\",\n \"smart_lock_provider\": \"\"\n },\n \"wordings\": {\n \"customer\": \"\",\n \"group\": \"\",\n \"room\": \"\"\n },\n \"usage\": {\n \"extras\": \"\",\n \"recording_sessions\": \"\",\n \"audio_uploads\": \"\",\n \"custom_questions\": \"\",\n \"regular_bookings\": \"\",\n \"coupons\": \"\",\n \"credit_balance\": \"\",\n \"multi_location\": \"\",\n \"locations\": \"\"\n },\n \"payments\": {\n \"stripe_connected\": \"\",\n \"square_connected\": \"\",\n \"square_terminal\": \"\",\n \"manual_payments\": \"\"\n },\n \"plan\": {\n \"name\": \"\",\n \"max_rooms\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "dashboard", "description": "", "item": [ { "id": "0e71c277-1e66-45a8-8a60-bb452a0f5bbf", "name": "Dashboard composite data", "request": { "name": "Dashboard composite data", "description": { "content": "Returns rooms, today's bookings, blocked times, opening time, slot length, and timezone in a single call.\nPowers the ePOS home screen. Accepts optional `from` and `to` date parameters for a date range,\nor a single `date` parameter. Defaults to today.\n", "type": "text/plain" }, "url": { "path": [ "dashboard" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Single date (defaults to today)", "type": "text/plain" }, "key": "date", "value": "" }, { "disabled": false, "description": { "content": "Start of date range", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End of date range", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "68276b0f-e49d-4056-aa5e-956f23735796", "name": "Dashboard data", "originalRequest": { "url": { "path": [ "dashboard" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Single date (defaults to today)", "type": "text/plain" }, "key": "date", "value": "" }, { "disabled": false, "description": { "content": "Start of date range", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End of date range", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rooms\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"space_for\": \"\",\n \"order\": \"\",\n \"twenty_four_hour_booking\": \"\",\n \"space_type\": \"\",\n \"hex_colour\": \"\",\n \"active\": \"\",\n \"prices_set\": \"\",\n \"price_to\": \"\",\n \"price_from\": \"\",\n \"images\": [\n {\n \"original\": \"\"\n },\n {\n \"original\": \"\"\n }\n ],\n \"data\": {}\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"space_for\": \"\",\n \"order\": \"\",\n \"twenty_four_hour_booking\": \"\",\n \"space_type\": \"\",\n \"hex_colour\": \"\",\n \"active\": \"\",\n \"prices_set\": \"\",\n \"price_to\": \"\",\n \"price_from\": \"\",\n \"images\": [\n {\n \"original\": \"\"\n },\n {\n \"original\": \"\"\n }\n ],\n \"data\": {}\n }\n ],\n \"bookings\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"band_name\": \"\",\n \"is_recording\": \"\",\n \"session_name\": \"\",\n \"block_colour_override\": \"\",\n \"studio_notes\": \"\",\n \"additional_notes\": \"\",\n \"number_expected\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"split\": \"\",\n \"room_name\": \"\",\n \"has_amount_due\": \"\",\n \"amount_due\": \"\",\n \"payments_recieved\": \"\",\n \"regular\": \"\",\n \"incomplete\": \"\",\n \"show_studio_notes\": \"\",\n \"extras_summary\": [\n \"\",\n \"\"\n ],\n \"link\": \"\",\n \"type\": \"\",\n \"class\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"title\": \"\",\n \"band_name\": \"\",\n \"is_recording\": \"\",\n \"session_name\": \"\",\n \"block_colour_override\": \"\",\n \"studio_notes\": \"\",\n \"additional_notes\": \"\",\n \"number_expected\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"split\": \"\",\n \"room_name\": \"\",\n \"has_amount_due\": \"\",\n \"amount_due\": \"\",\n \"payments_recieved\": \"\",\n \"regular\": \"\",\n \"incomplete\": \"\",\n \"show_studio_notes\": \"\",\n \"extras_summary\": [\n \"\",\n \"\"\n ],\n \"link\": \"\",\n \"type\": \"\",\n \"class\": \"\"\n }\n ],\n \"blocked_times\": [\n {\n \"id\": \"\",\n \"room_id\": \"\",\n \"reason\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"room\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"room_id\": \"\",\n \"reason\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"room\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n }\n }\n ],\n \"opening_time\": \"\",\n \"slot_length\": \"\",\n \"timezone\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "booking_price", "description": "", "item": [ { "id": "a698844d-2a1f-457e-a5a0-e32a8c57351b", "name": "Calculate booking price", "request": { "name": "Calculate booking price", "description": { "content": "Real-time price calculation with extras, tax, and staff costs.\nProvide either a `booking_code` to calculate from an existing booking,\nor `price.hours` and `price.price` for a custom calculation.\n", "type": "text/plain" }, "url": { "path": [ "booking_price" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_price\": {\n \"booking_code\": \"\",\n \"price\": {\n \"hours\": \"\",\n \"days\": \"\",\n \"price\": \"\"\n },\n \"extras\": [\n {\n \"id\": \"\",\n \"quantity\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\"\n }\n ],\n \"staff_ids\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4807391a-962d-4327-b7a1-0b7a900d2238", "name": "Price breakdown", "originalRequest": { "url": { "path": [ "booking_price" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_price\": {\n \"booking_code\": \"\",\n \"price\": {\n \"hours\": \"\",\n \"days\": \"\",\n \"price\": \"\"\n },\n \"extras\": [\n {\n \"id\": \"\",\n \"quantity\": \"\"\n },\n {\n \"id\": \"\",\n \"quantity\": \"\"\n }\n ],\n \"staff_ids\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hours\": \"\",\n \"days\": \"\",\n \"time_cost\": \"\",\n \"extras_total\": \"\",\n \"staff_total\": \"\",\n \"subtotal\": \"\",\n \"tax_total\": \"\",\n \"total\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "slot_projection", "description": "", "item": [ { "id": "9280fb2a-f872-4e87-b221-c33119ac16c0", "name": "Project time slot", "request": { "name": "Project time slot", "description": { "content": "Preview cost and check conflicts for a time slot.", "type": "text/plain" }, "url": { "path": [ "slot_projection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"projection_params\": {\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"date\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"room_id\": \"\",\n \"room_code\": \"\",\n \"booking_code\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2c32911c-072d-4bef-804e-44afe7428943", "name": "Slot projection", "originalRequest": { "url": { "path": [ "slot_projection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"projection_params\": {\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"date\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"room_id\": \"\",\n \"room_code\": \"\",\n \"booking_code\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"cost\": \"\",\n \"hours\": \"\",\n \"days\": \"\",\n \"explanation\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "extras", "description": "", "item": [ { "id": "893d97e8-d55f-4563-ab3b-c2c28d9726a4", "name": "List extras", "request": { "name": "List extras", "description": { "content": "All available add-on items with pricing.", "type": "text/plain" }, "url": { "path": [ "extras" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c7876b66-a3eb-4fdd-9ba3-23148532e355", "name": "Extras list", "originalRequest": { "url": { "path": [ "extras" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"category\": \"\",\n \"available\": \"\",\n \"can_add_multiple_quantity\": \"\",\n \"track_stock\": \"\",\n \"price_per_use\": \"\",\n \"price_per_hour\": \"\",\n \"price_per_daily\": \"\",\n \"price_per_weekly\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"category\": \"\",\n \"available\": \"\",\n \"can_add_multiple_quantity\": \"\",\n \"track_stock\": \"\",\n \"price_per_use\": \"\",\n \"price_per_hour\": \"\",\n \"price_per_daily\": \"\",\n \"price_per_weekly\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "00ea0eb2-6506-40fd-88a6-bc71869da77a", "name": "Show extra", "request": { "name": "Show extra", "description": { "content": "Single extra with stock and pricing detail.", "type": "text/plain" }, "url": { "path": [ "extras", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "446f7643-1a22-40c1-bf80-b71b58e5749a", "name": "Extra detail", "originalRequest": { "url": { "path": [ "extras", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"code\": \"\",\n \"category\": \"\",\n \"available\": \"\",\n \"can_add_multiple_quantity\": \"\",\n \"track_stock\": \"\",\n \"price_per_use\": \"\",\n \"price_per_hour\": \"\",\n \"price_per_daily\": \"\",\n \"price_per_weekly\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "rooms", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "b70f4671-d7fe-41c4-9155-c938d0aef5f4", "name": "Show room", "request": { "name": "Show room", "description": { "content": "Room detail with images, pricing, and capacity.", "type": "text/plain" }, "url": { "path": [ "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d4427cbc-35ff-4f65-b5cb-a6b2e01f4631", "name": "Room detail", "originalRequest": { "url": { "path": [ "rooms", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"space_for\": \"\",\n \"order\": \"\",\n \"twenty_four_hour_booking\": \"\",\n \"space_type\": \"\",\n \"hex_colour\": \"\",\n \"active\": \"\",\n \"prices_set\": \"\",\n \"price_to\": \"\",\n \"price_from\": \"\",\n \"images\": [\n {\n \"original\": \"\"\n },\n {\n \"original\": \"\"\n }\n ],\n \"data\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "notifications", "description": "", "item": [ { "id": "71d1edf9-22f3-454f-9562-843c735c42f2", "name": "List notifications", "request": { "name": "List notifications", "description": { "content": "Recent notifications from the last 7 days.", "type": "text/plain" }, "url": { "path": [ "notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "66874e0c-1abc-4ff9-9cc2-254ecb48bc64", "name": "Notifications", "originalRequest": { "url": { "path": [ "notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"title\": \"\",\n \"body\": \"\",\n \"severity\": \"high\",\n \"label\": \"\",\n \"read\": \"\",\n \"created_at\": \"\",\n \"read_at\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"body\": \"\",\n \"severity\": \"high\",\n \"label\": \"\",\n \"read\": \"\",\n \"created_at\": \"\",\n \"read_at\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "name": "read", "description": "", "item": [ { "id": "56341a74-5cf3-457d-838b-339f8773f377", "name": "Mark as read", "request": { "name": "Mark as read", "description": {}, "url": { "path": [ "notifications", ":id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "93994047-0797-4c56-9f73-4bd8d151f2d4", "name": "Marked as read", "originalRequest": { "url": { "path": [ "notifications", ":id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "archive", "description": "", "item": [ { "id": "d9c47443-c4fb-41fc-a120-b8074a0392b2", "name": "Archive notification", "request": { "name": "Archive notification", "description": {}, "url": { "path": [ "notifications", ":id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "eb540322-2947-41bd-9872-c90b4850a505", "name": "Archived", "originalRequest": { "url": { "path": [ "notifications", ":id", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "clear", "description": "", "item": [ { "id": "2f660b64-6cd5-4db7-9ff8-2fcc151d3b46", "name": "Clear all notifications", "request": { "name": "Clear all notifications", "description": {}, "url": { "path": [ "notifications", "clear" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "df7985df-8207-45b5-a775-7999a1012233", "name": "All notifications cleared", "originalRequest": { "url": { "path": [ "notifications", "clear" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "blocked_times", "description": "", "item": [ { "id": "d301f88b-6ff2-4b51-97a1-14b40c7d88c2", "name": "List blocked times", "request": { "name": "List blocked times", "description": { "content": "Get all future schedule blocks.", "type": "text/plain" }, "url": { "path": [ "blocked_times" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ae626c43-dd7e-4903-8d5e-9205f3573c43", "name": "Blocked times", "originalRequest": { "url": { "path": [ "blocked_times" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"room_id\": \"\",\n \"reason\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"room\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"room_id\": \"\",\n \"reason\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"room\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a26d3cac-5970-42a4-9acf-478fbd46edfb", "name": "Create blocked time", "request": { "name": "Create blocked time", "description": { "content": "Block a room/time slot for maintenance, private events, etc.", "type": "text/plain" }, "url": { "path": [ "blocked_times" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"blocked_time\": {\n \"room_id\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1c47d774-2c71-48fd-a001-328ef1c73c3f", "name": "Blocked time created", "originalRequest": { "url": { "path": [ "blocked_times" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"blocked_time\": {\n \"room_id\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"room_id\": \"\",\n \"reason\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"room\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "5639b7a5-7402-4c98-badc-914edaaeda13", "name": "Update blocked time", "request": { "name": "Update blocked time", "description": {}, "url": { "path": [ "blocked_times", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"blocked_time\": {\n \"room_id\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a50db519-e8e4-48f8-842f-1ae89a5b4b8c", "name": "Blocked time updated", "originalRequest": { "url": { "path": [ "blocked_times", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"blocked_time\": {\n \"room_id\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"reason\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"room_id\": \"\",\n \"reason\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"room\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae3fdffd-be7f-43b8-b5c5-58e26dd6cd81", "name": "Delete blocked time", "request": { "name": "Delete blocked time", "description": {}, "url": { "path": [ "blocked_times", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "37a94c54-4540-495b-9421-a7cbb1b8f93e", "name": "Blocked time deleted", "originalRequest": { "url": { "path": [ "blocked_times", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "booking_anchors", "description": "", "item": [ { "id": "bc6cbd29-ce80-4bfe-a6d9-32194dfd3a3f", "name": "List booking anchors", "request": { "name": "List booking anchors", "description": { "content": "List booking anchors, ordered by date, start time and room. Without a `date` only today's and future anchors are returned; pass a `date` to reach a past day.\n\nResults are paginated, with the totals in the `jammed-total-count`, `jammed-page-count`, `jammed-next-page` and `jammed-prev-page` response headers.\n\nRequires the `bookings.read` scope when using OAuth tokens.\n", "type": "text/plain" }, "url": { "path": [ "booking_anchors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only anchors on this day (YYYY-MM-DD)", "type": "text/plain" }, "key": "date", "value": "" }, { "disabled": false, "description": { "content": "Only anchors in this room", "type": "text/plain" }, "key": "room_id", "value": "" }, { "disabled": false, "description": { "content": "Only anchors starting at this time of day (HH:MM), in the studio's timezone", "type": "text/plain" }, "key": "time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "eb0351f7-67ea-4852-97c6-106e9663af86", "name": "Booking anchors", "originalRequest": { "url": { "path": [ "booking_anchors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only anchors on this day (YYYY-MM-DD)", "type": "text/plain" }, "key": "date", "value": "" }, { "disabled": false, "description": { "content": "Only anchors in this room", "type": "text/plain" }, "key": "room_id", "value": "" }, { "disabled": false, "description": { "content": "Only anchors starting at this time of day (HH:MM), in the studio's timezone", "type": "text/plain" }, "key": "time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"room_id\": \"\",\n \"date\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"duration\": \"\",\n \"source\": \"manual\",\n \"booking_code\": \"\",\n \"room\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"room_id\": \"\",\n \"date\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"duration\": \"\",\n \"source\": \"api\",\n \"booking_code\": \"\",\n \"room\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c35f1579-1566-48b3-a99b-499c6d91a54d", "name": "Bad request - the `date` could not be parsed", "originalRequest": { "url": { "path": [ "booking_anchors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only anchors on this day (YYYY-MM-DD)", "type": "text/plain" }, "key": "date", "value": "" }, { "disabled": false, "description": { "content": "Only anchors in this room", "type": "text/plain" }, "key": "room_id", "value": "" }, { "disabled": false, "description": { "content": "Only anchors starting at this time of day (HH:MM), in the studio's timezone", "type": "text/plain" }, "key": "time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "118fc159-f1a7-4296-b054-1565ad76bf9d", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "booking_anchors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only anchors on this day (YYYY-MM-DD)", "type": "text/plain" }, "key": "date", "value": "" }, { "disabled": false, "description": { "content": "Only anchors in this room", "type": "text/plain" }, "key": "room_id", "value": "" }, { "disabled": false, "description": { "content": "Only anchors starting at this time of day (HH:MM), in the studio's timezone", "type": "text/plain" }, "key": "time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f44f96cd-b8e5-4f0a-9f8f-0aaaa1dd7ae9", "name": "Forbidden - the OAuth token lacks the scope, or does not belong to an admin", "originalRequest": { "url": { "path": [ "booking_anchors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only anchors on this day (YYYY-MM-DD)", "type": "text/plain" }, "key": "date", "value": "" }, { "disabled": false, "description": { "content": "Only anchors in this room", "type": "text/plain" }, "key": "room_id", "value": "" }, { "disabled": false, "description": { "content": "Only anchors starting at this time of day (HH:MM), in the studio's timezone", "type": "text/plain" }, "key": "time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d98a66cb-a25c-4c14-9057-d0b0cf2b5796", "name": "Unprocessable - sticky bookings are not turned on", "originalRequest": { "url": { "path": [ "booking_anchors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only anchors on this day (YYYY-MM-DD)", "type": "text/plain" }, "key": "date", "value": "" }, { "disabled": false, "description": { "content": "Only anchors in this room", "type": "text/plain" }, "key": "room_id", "value": "" }, { "disabled": false, "description": { "content": "Only anchors starting at this time of day (HH:MM), in the studio's timezone", "type": "text/plain" }, "key": "time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "966f72ce-5fc4-4d6f-aaf2-46c9b911c4c1", "name": "Create booking anchor", "request": { "name": "Create booking anchor", "description": { "content": "Anchor a span of time in a room so only the slots immediately before and after it stay bookable that day. Takes the same fields as the admin form: a room and a start and end time.\n\nThe anchor's `date` and `duration` are worked out from `start_at` and `end_at`, and its `source` is always `api`. Times without a UTC offset are read in the studio's timezone.\n\nRequires the `bookings.write` scope when using OAuth tokens.\n", "type": "text/plain" }, "url": { "path": [ "booking_anchors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_anchor\": {\n \"room_id\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b59e44a2-9867-48c9-b691-5f8a9de060ea", "name": "Booking anchor created", "originalRequest": { "url": { "path": [ "booking_anchors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_anchor\": {\n \"room_id\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"room_id\": \"\",\n \"date\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"duration\": \"\",\n \"source\": \"manual\",\n \"booking_code\": \"\",\n \"room\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b7d32e2-184e-46a8-be34-0e7cd0e2e3be", "name": "Bad request - the `booking_anchor` key is missing", "originalRequest": { "url": { "path": [ "booking_anchors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_anchor\": {\n \"room_id\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b5c01cb7-b606-478f-955d-57345485f92b", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "booking_anchors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_anchor\": {\n \"room_id\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "65ff6287-088e-422d-aff3-c65a1d83cd3b", "name": "Forbidden - the OAuth token lacks the scope, or does not belong to an admin", "originalRequest": { "url": { "path": [ "booking_anchors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_anchor\": {\n \"room_id\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e9c94b0-ad0e-4300-a4d8-c2b8359c8e9c", "name": "Unprocessable - the room does not exist, the times are missing or backwards, or sticky bookings are not turned on", "originalRequest": { "url": { "path": [ "booking_anchors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_anchor\": {\n \"room_id\": \"\",\n \"start_at\": \"\",\n \"end_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "1d6b2ac1-02d3-463d-a899-4e60ed947ca2", "name": "Delete booking anchor", "request": { "name": "Delete booking anchor", "description": { "content": "Delete any booking anchor, whatever its source. Deleting an `auto` anchor reopens that day for its room, but Jammed recreates it the next time it syncs anchors from that booking (for example when the booking changes), as it does in the admin.\n\nThere is no update endpoint: to move an anchor, delete it and create a new one.\n\nRequires the `bookings.write` scope when using OAuth tokens.\n", "type": "text/plain" }, "url": { "path": [ "booking_anchors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "9d96e7d3-2fee-4b5d-82d8-f4eb166c84b2", "name": "Booking anchor deleted", "originalRequest": { "url": { "path": [ "booking_anchors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33d6caf1-1cc4-452b-87f7-ebee3997f45d", "name": "Unauthorized - Invalid API key", "originalRequest": { "url": { "path": [ "booking_anchors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "97751013-11f1-4bee-b4ec-e6e91b8c68e9", "name": "Forbidden - the OAuth token lacks the scope, or does not belong to an admin", "originalRequest": { "url": { "path": [ "booking_anchors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "689ef948-ee5a-4a9f-8e32-a73f052ab4e5", "name": "Not found - the booking anchor does not exist", "originalRequest": { "url": { "path": [ "booking_anchors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7d11c88e-954a-44c5-ad91-3b82a8a67dda", "name": "Unprocessable - sticky bookings are not turned on", "originalRequest": { "url": { "path": [ "booking_anchors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "recent_transactions", "description": "", "item": [ { "id": "1c6dc423-eced-4c6d-9db6-a8fc9dd0d7b6", "name": "Recent transactions", "request": { "name": "Recent transactions", "description": { "content": "Today's and yesterday's transaction totals by payment method (Stripe, Square, manual cash/card/other).", "type": "text/plain" }, "url": { "path": [ "recent_transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "918b8695-5bb6-4ccf-8ad7-c6e49396a1ef", "name": "Transaction summaries", "originalRequest": { "url": { "path": [ "recent_transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"today\": {\n \"date\": \"\",\n \"stripe\": \"\",\n \"stripe_refunds\": \"\",\n \"square\": \"\",\n \"square_refunds\": \"\",\n \"square_terminal\": \"\",\n \"square_terminal_refunds\": \"\",\n \"manual_total\": \"\",\n \"manual_cash\": \"\",\n \"manual_card\": \"\",\n \"manual_other\": \"\",\n \"total_taken\": \"\",\n \"total_refunded\": \"\",\n \"total\": \"\"\n },\n \"yesterday\": {\n \"date\": \"\",\n \"stripe\": \"\",\n \"stripe_refunds\": \"\",\n \"square\": \"\",\n \"square_refunds\": \"\",\n \"square_terminal\": \"\",\n \"square_terminal_refunds\": \"\",\n \"manual_total\": \"\",\n \"manual_cash\": \"\",\n \"manual_card\": \"\",\n \"manual_other\": \"\",\n \"total_taken\": \"\",\n \"total_refunded\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "money_ledger", "description": "", "item": [ { "id": "5a6e124b-0e76-45df-b5a2-412277f081d9", "name": "Money ledger", "request": { "name": "Money ledger", "description": { "content": "Searchable transaction history with pagination.", "type": "text/plain" }, "url": { "path": [ "money_ledger" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search query (source, transaction ID, booking code, customer name/email)", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c27da68a-67d6-4670-84d8-ebc0055f9168", "name": "Money logs", "originalRequest": { "url": { "path": [ "money_ledger" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search query (source, transaction ID, booking code, customer name/email)", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"source\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"transaction_id\": \"\",\n \"created_at\": \"\",\n \"source_data\": {},\n \"booking\": {\n \"code\": \"\",\n \"name\": \"\"\n },\n \"customer\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"source\": \"\",\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"transaction_id\": \"\",\n \"created_at\": \"\",\n \"source_data\": {},\n \"booking\": {\n \"code\": \"\",\n \"name\": \"\"\n },\n \"customer\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.jammed.app/api/v2/" }, { "key": "code", "value": "" }, { "key": "id", "value": "" } ], "info": { "_postman_id": "eca6e11b-230c-4898-b7ff-7b39d24c454e", "name": "Jammed Bookings API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Jammed API allows you to integrate with the Jammed system, and automate key events within third-party systems. We are adding endpoints and features as we need them and as studios request them. If there's an endpoint you need, please contact us.\n\nBy subscribing to and listening to webhooks your studio can automate sending reminders, automate customer lists and mailing\nsystems, finance and accounting packages, and anything you can imagine really.\n\n# Introduction\nJammed is powering scheduling and bookings for independent creative spaces, and we're building a new way to connect with them.\nYou can read more about [Jammed on the support pages](https://support.jammedapp.com).\n\nJammed offers webhooks and a polling API, so you can integrate how ever you like with the system.\n\nYou can also see the version history and roadmap for the [Jammed API on the public Github project](https://github.com/jammed-org/api).\n\n# Authentication\nYou authenticate with the API using an API key - this is found in the website settings of the admin section.\n\nIssue this header with all requests to the API or it will return a `401 Unauthorized` error.\n\n\n\n# Getting started\nTo get started, you'll need to create a Jammed account and create a studio account.\n\nOnce you have setup your studio, head the to Website Setting page and press the 'Enable webhooks' button. From there, you can set the webhook URLs you want Jammed to send to.\n\n\nContact Support:\n Email: api@jammed.app", "type": "text/plain" } } }