{ "item": [ { "name": "bookings.json", "description": "", "item": [ { "id": "bb011f47-1ea5-4284-b3f1-defd31189d3d", "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": "e832763b-a05b-439d-8e37-624dfa9b27e3", "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": "e39fad45-b0bb-4639-a1c8-f28382482b41", "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": "e1edca94-ada3-43dc-a449-38d2d2790557", "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": "f5c49c55-8440-4dc3-a9cb-d33ab55c6986", "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": "66a88b36-35a8-44d7-bf6f-b02012ff96e8", "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": "217b35e7-93be-4f6c-8ddd-e71bef37f2bb", "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": "f6c67c62-37ca-408f-af24-8fbc48345599", "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": "21f067f1-3296-46c2-8e06-ace4a9ae8dc7", "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": "ba1baa36-aa61-4f61-9938-b34664592caa", "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": "5050fc59-7d53-4c8d-a7a7-abda7a9a16a2", "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": "deace663-aaf4-4720-9c4c-0f952d713f83", "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": "ace7668f-ac95-490f-8b66-0717f30c557e", "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": "37e50dc5-6748-4e0b-96fb-684d54ce93cf", "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": "bfe2b0b8-e579-40d1-9686-5b49e07b1d04", "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": "86507221-33d1-4bf0-9267-7d1ac2c77241", "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": "f29eb40a-1369-45f4-b9b9-34c36e7468b2", "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": "d49c9f10-2db9-43ec-a57c-59cdddabd370", "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": "7e37c337-6c92-430b-bd41-dc18bb7c7877", "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": "e2443992-fcef-4564-a055-1c5d145319a6", "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": "f7bbddc0-6fee-45c5-83b1-244d64a46140", "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": "b74b4e03-3cb9-4cdb-afb3-0bb37f5d4081", "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": "83eaa9cb-adc8-4779-8eb7-d9bd9bcdfbb3", "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": "a7158b73-0598-40f5-a3cf-e991e6a8cb61", "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": "4cbe50ec-6a48-480a-82d6-5b7c0c833120", "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": "2622a2a2-ec73-45b8-8bb1-0eedbce64bf6", "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": "fba8f219-e2bc-4ec1-8cc5-005d9ae16c11", "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": "e9fed2b7-876a-425b-bed4-5480461e9525", "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": "998ccb9c-5b5b-4022-acd2-efa0434c539a", "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": "202065bb-1d85-4643-a039-f8e019ba08e4", "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": "049b9e7e-4f21-49d3-9867-17682ea9c31c", "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": "a5079fa7-0311-49c9-935b-048d20172a3a", "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": "f558fc09-3cca-4e8b-9461-7125853ebc17", "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": "4cbc67d0-05fc-4fcb-a812-3d034b4bb1cd", "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": "f3cd094f-16e2-4f21-a10c-986683cf60bd", "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": "aebc9979-66fe-4812-8215-1e8b56379647", "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": "5e36c6b6-6a50-42b7-90bb-81f74f0e4ac8", "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": "22f5dfbb-917d-4b45-83ff-bbe5711c4d29", "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": "49416018-3970-4f99-a0b9-5f8446d2a846", "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": "c26b4a03-10cf-48c8-bad4-60235646d21b", "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": "d2161725-6202-429d-9dc9-bbc923f8b9c1", "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": "32a0ada1-eb9c-45c5-81ae-8243ed41591a", "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": "174fb77a-6f62-40c1-b5e1-fbccd404c4c5", "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": "d0a8a8ad-c820-4852-a809-ffb2f1af8b80", "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": "cabcd6cf-2c10-4d2d-b1e1-f076b48e66e9", "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": "ad66b366-ab0a-4c34-b7b4-c3747a2e86ca", "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": "7d0717e1-037d-40c5-81e0-f44087c8f98f", "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": "cbf69361-a2a5-48da-b9af-c82feeee26a9", "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": "e7719834-71fd-410a-b175-9da8df45f989", "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": "989b89e6-b065-446d-a2ae-95285c2447f2", "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": "b5144576-f859-4044-a1d5-287cdcaf3694", "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": "c8df05ee-065f-482d-b345-1e37cf97cd75", "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": "c2df7b10-f1ea-49f5-aa39-5c2045aa5892", "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": "022f81a7-e48c-44c3-92c3-ce48d688b6f1", "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": "fef3948c-8b1a-44e0-ab5b-e39c88739882", "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": "869be45e-f8c2-4f8d-9f91-a1bd2a7df7eb", "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": "fe4b97b8-ea00-445d-97fc-f8f61760d4f5", "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": "fe354499-f444-47f8-a5e2-428d61495482", "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": "295fe889-f3f5-4ec3-965f-a5874bd79301", "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": "1bc9640f-1fb9-4963-9d22-695dba3f3ea8", "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": "ad474994-3ee9-43a7-a25e-71003c634a58", "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": "ae9c9d9a-39d9-48ed-a55c-1fc7443f2197", "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": "fbede2ba-11df-4e4a-9daf-73a568aa8a46", "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": "4f95426d-9887-4dc2-aada-a3e16c79a038", "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": "6a795889-3853-4930-b65b-c811697d68fb", "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": "03a59f65-4013-4485-a877-32a0b3408479", "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": "b7ff5dbb-6a9d-42f4-9f21-66a92733ef3e", "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": "48764841-9dbd-454c-9925-67e2a7f9dea6", "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": "36ef39e8-2335-4cb5-aee4-df669277f305", "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": "2c4c7b0e-c8d1-43b6-a1fc-5d88a6daab35", "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": "5d930925-d240-4e8c-9eb8-90e3b0a77003", "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": "9a5231ba-f105-4df7-b7c7-07082f782bdd", "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": "f0baf852-9aa6-4d39-a728-e4b03670debf", "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": "42d071ba-8daf-4e43-befb-d17225af452f", "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": "9494bb61-2621-44ab-a635-736e0b07b357", "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": "0e88266e-941c-4444-9b0f-b343fdd87425", "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": "8a62aab2-9f43-41e6-b5ec-1b0277be7fdf", "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": "795a6d75-a4e6-42cf-beed-6dd4af242308", "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": "51f26296-93bc-4547-a8c9-908f391741f6", "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": "6d10c0d4-3828-443b-a454-55383df01925", "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": "c9e1f053-cc39-4cc8-9ca9-f200f86a1df2", "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": "72fc4e81-6573-4d58-9dab-12f14046fc1f", "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": "58e1ddea-3a46-450f-830f-9e7fb033d0b7", "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": "1d1b0550-538c-4ed9-868c-64b9b56bde46", "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": "251e5928-96e7-4ed2-8aeb-13aec39384aa", "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": "69eb18aa-254a-4173-8177-2ddf0596eeb8", "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": "6da2cecf-adff-4c81-b8fa-52e6aaf6e883", "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": "41918eb3-1765-4539-a1c1-fd30b49084dc", "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": "e95ba849-0168-401f-be5a-a077e55cf2f0", "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": "b3d807a3-b8f9-4c91-bcc8-963299bb4d43", "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": "07d94bbe-05c5-4325-ab66-aa13d8212f83", "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": "f2bf1306-91ce-469f-977d-8595ae665d10", "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\": \"other\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ee4bb4d9-80e6-4e15-88b7-9188a8bfe6e3", "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\": \"other\"\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": "a1b4d2b1-1641-4b7b-ab19-3b29892a0d3f", "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": "4534317e-2e0f-4e45-af22-276a7e801adc", "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": "7594dde3-556a-4ada-bafc-f5c3fd48df25", "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": "a1becf20-64bc-4bfa-ab00-59ba0f9ca28d", "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": "cancelled" }, { "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": "9fe69a18-54e8-4737-b761-6f488ed93938", "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": "cancelled" }, { "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": "2bb9316b-e01e-4da0-9028-4b2b6b1ef823", "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": "f88efcd0-ac94-455d-a86d-709310a5a43e", "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": "bf8279b7-8561-4b86-821f-6c84993376f0", "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": "4fb7055e-c4a1-4118-832b-907c9b98f84b", "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": "031f2d46-c72a-4926-b377-eeb2017fe73c", "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": "9faca4da-0002-45c6-a4c6-256a5555cd55", "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\": \"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 },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"avatar\": \"\",\n \"credit_balance\": \"\",\n \"status\": \"invited\",\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": "a1db8b2d-9053-49fc-b729-91bf11bf93f4", "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": "5ba59d78-36da-481b-920f-2ea04ae4bb2c", "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": "f94f3d8b-7636-4562-a223-55706cc8b8ee", "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\": \"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 },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"avatar\": \"\",\n \"credit_balance\": \"\",\n \"status\": \"invited\",\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": "eb67bb77-8c8d-4909-920e-2da7dd6b380e", "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": "4a1f9386-b47d-438c-9a4d-429f8ab6e8a8", "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": "fd4be0db-38e3-4879-b19f-ba2b46e057b0", "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": "46874ce0-4bf1-406b-a8c8-a135fa080ac5", "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\": \"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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ba5e4f2-b713-48e0-b36f-0ba91fd62b97", "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": "a6794913-3cc3-48a0-b7bd-34db33b01d74", "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": "a5c0c929-e63b-4b07-a6f5-087753f41451", "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": "a786895d-4f4b-4fed-af49-39910cb9b156", "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\": \"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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "notes", "description": "", "item": [ { "id": "9b79abb7-b193-476d-a6d0-cea2772cde0e", "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": "d01e45e5-02ff-4dd7-854a-4b8e9e5c865d", "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\": \"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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "invite", "description": "", "item": [ { "id": "ad1f2c34-b11d-4b53-bf7c-bd077d74c89c", "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": "27f7c959-a147-47d5-90f0-b7e919960b3f", "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\": \"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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bfe24e8-c64b-44ec-b37f-6180944c3ff2", "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": "27d926b1-15d8-4dea-a278-df640c46adf2", "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": "3a80f070-a16f-4c0b-a2f3-85a0e06aa791", "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": "e284aeb2-7283-40d5-904f-c8f1a5697f17", "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": "e5160da8-9c16-481e-a104-4961f9535ab2", "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": "77268f0d-9135-4d6d-9316-e5af2897cf4e", "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": "3d96222f-3326-4f21-b23e-f65cc9a981cb", "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": "e1b92dcc-a62c-4b74-9c95-01464706e8e5", "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": "72760006-7d62-4332-af50-20267231f0d7", "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": "7d45ab5b-fa61-4cfd-8cac-6e46bc4905a4", "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": "eb3400f2-7081-4b44-a787-7cdd678ba45c", "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": "8a994950-ec7b-471d-a6ce-7bfd9bb1f72b", "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": "bd086216-b1fd-40e4-80a3-29cad3b652e8", "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": "330044f1-291f-4918-874b-483e98127ade", "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": "4028e7b6-be92-4796-8cc9-d26ce5eed27b", "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": "6a0490bd-619d-4299-aaa4-35e271d7fa6d", "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": "7ca1d088-4359-4304-aa52-5db7eff03639", "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": "3d6608a5-d95a-4f06-b253-a8b017ed4005", "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": "3e6e794c-77e4-4be7-bda4-593d3825ce99", "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": "67efc5af-bc59-4174-a6f9-e6ba50a0e725", "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": "ad678f2a-e55a-476b-8c2a-f07363b3867c", "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": "66703288-0de5-46c2-b0b1-a7acc0ec249c", "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": "0e58674d-e51c-4cee-9373-b8c31b20614f", "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": "4939e7f9-6025-4796-adb4-32f71b895821", "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": "c0c2cf2b-f28f-4716-8386-96630bc75fe4", "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": "e292f914-8499-45ed-8bbf-ca945e4c4db9", "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": "73383065-09c1-48ac-ae01-f652c9c69228", "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": "b244c33d-710f-418f-aac9-827dc8f258f8", "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": "fab04a25-eb5c-4b9d-b164-77531eb4c2b8", "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": "33ac9f80-5916-4f8b-acb8-350d804ded5b", "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": "331cb682-8bb9-4c96-87e5-134b221d7b38", "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": "30e212b8-c801-4ed1-ae1d-0e6c0e253897", "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": "5ede3c60-d12b-4f35-8b52-bd38f9009d77", "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": "0a93eb4d-7eee-4f6f-811f-fd6f57396e6d", "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": "1b702b42-253a-481a-b5ea-04d7650e1013", "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": "4f7ad5f8-8836-4bf2-b0b5-1dbd7c73d964", "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": "f21322aa-b120-4639-8ae0-5160471e48c3", "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": "58aa768e-fa55-48bf-bf43-0c6af406a3a0", "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": "b3d99eee-2ddf-45aa-9983-7efe54db0348", "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": "92edea62-016a-499e-b00c-648692b3fa1b", "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": "58364ca3-3cbd-4866-b736-9470c494e880", "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": "3090a328-2199-4e39-bcfd-9c775809e95f", "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": "281d5444-255d-440e-a6dd-158495048f9e", "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": "d44afb63-c8b8-444a-83d5-f966cf25a83e", "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": "b635033f-91a4-4c0d-aa65-2489b9a7fd5f", "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": "6c794fe4-d8e5-417d-b718-755fefefa1f1", "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": "c42d7152-7d93-4954-8cd9-9205f501b346", "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": "641a983a-70d5-4a28-a7e1-ba175129b321", "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": "e6cb13e1-b6e1-468d-9c9e-a78687e30e39", "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": "86fa6579-45e2-4e88-8ef8-b88dbc0a2a3a", "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": "e4986d2e-f00d-4d36-a637-841dd5add3c9", "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": "68992561-ae83-44fe-89d8-4a0ee6c7ea1d", "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": "ce6b0786-a2d1-4b69-b939-6d6cedadfb36", "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": "a5f84004-d618-4ac0-afa9-6f6c4c2061cd", "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": "a63dfac5-87a5-4d7e-8be5-8713f03934af", "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": "48f1575b-5d10-488d-b0ad-0cc8a3751ba2", "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": "2149822c-f6c9-4f50-ab52-2b5a91294aa7", "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": "097f2389-47bd-4588-ab6e-a06538b945f5", "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": "465fdffd-0e62-4166-af01-3b664a38cef1", "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": "1312c22b-74c9-415f-bf8d-8a34603aced2", "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": "8630a765-8688-4052-8884-133fd1d0ac70", "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\": \"normal\",\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": "f75cf3dc-8132-407d-a3cb-9cd220f7f893", "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": "9b59977d-a7bc-4f49-bded-368a505b85f7", "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": "8a06ee11-be86-4eb3-87e6-6f0f9833f5af", "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": "f1e64568-656d-432f-b72c-45e56b052e50", "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": "88b1baa0-c8a5-428d-b3c3-f23135158e38", "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": "1b5ed09d-cd76-4127-bce9-a1994e26325f", "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": "7ce6bdb2-a628-4d71-ae64-f6ac36849974", "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": "b181b2e1-35bd-41c7-9358-5a766d0d3d3b", "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": "63d8eca9-b8ea-490f-bdc4-54b620aecd38", "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": "cacfa790-c6c1-4be7-9764-302896b698e6", "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": "ad2e81c1-246e-4467-aa2b-080757358e1d", "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": "90d5d53c-a63e-4b47-99c3-914f3a5195df", "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": "a4cd5eec-c102-4b30-b483-24131bb6d3c1", "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": "61d8735f-adfe-4c53-bda0-31edfbe2b451", "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": "recent_transactions", "description": "", "item": [ { "id": "13a9f0b8-090c-4e48-9cb5-250e74783b75", "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": "c7d54dea-93ea-4611-bcde-d77237899d37", "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": "3449910d-9594-40ec-a154-bf7a1f2b82db", "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": "e44d626c-3512-44b9-9c43-9356680ad669", "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": "db5b0d89-1754-47ba-9419-7af955320773", "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" } } }