{"openapi":"3.0.1","info":{"title":"Public API","version":"5.0.0"},"servers":[{"url":"https://{api_url}/api/v5","variables":{"api_url":{"default":"example.jrni.com"}}}],"security":[{"App-Id":[]}],"tags":[{"name":"Check_in"},{"name":"Service"},{"name":"Resource"},{"name":"Company"},{"name":"Event"},{"name":"Events"},{"name":"Event Group"},{"name":"Event Chain"},{"name":"Question"},{"name":"Category"},{"name":"Client"},{"name":"Booking Text"},{"name":"Address"},{"name":"Image"},{"name":"Package"},{"name":"Bulk Purchase"},{"name":"Booking"},{"name":"Terminology"},{"name":"Event Landing Page"},{"name":"Event Detail"},{"name":"Person"},{"name":"booking_links"},{"name":"Time"},{"name":"Opening Hours"},{"name":"Company Text"},{"name":"Guest"}],"paths":{"/{company_id}/check_in/{check_in_code}":{"get":{"tags":["Check_in"],"summary":"Get check in details","description":"Returns appointment or event details for a given check-in code","operationId":"getCompanyIdCheckInCheckInCode","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"check_in_code","in":"path","required":true,"schema":{"type":"string"}},{"name":"legacy_mode","in":"query","description":"For legacy check-in behavior","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Get check in details","content":{}}}},"put":{"tags":["Check_in"],"summary":"Check in to an appointment or event","description":"Marks the related appointment or event guest as checked in","operationId":"putCompanyIdCheckInCheckInCode","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"check_in_code","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Check in to an appointment or event","content":{}}}}},"/{company_id}/services/{id}":{"get":{"tags":["Service"],"summary":"Service Read","description":"Retrieves a bookable service.\nduration_unit may be minute, day, or week","operationId":"getCompanyIdServicesId","parameters":[{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Service Integer id or String name","required":true,"schema":{"type":"string"}},{"name":"embed","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Service","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}}}}},"/{company_id}/services/find_by_ref/{reference}":{"get":{"tags":["Service"],"summary":"Service Find By Reference","description":"Retrieves a bookable service.\nduration_unit may be minute, day, or week","operationId":"getCompanyIdServicesFindByRefReference","parameters":[{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"string"}},{"name":"reference","in":"path","description":"Service Integer id or String name","required":true,"schema":{"type":"string"}},{"name":"embed","in":"query","description":"A comma seperated list of resources to embed. Available: company, child_services, images","schema":{"type":"string"}}],"responses":{"200":{"description":"Service","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}}}}},"/{company_id}/services":{"get":{"tags":["Service"],"summary":"List Services","description":"Retrieves a list of bookable services.\nResults are returned as a paginated list.\nduration_unit may be minute, day, or week","operationId":"getCompanyIdServices","parameters":[{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":1000}},{"name":"api_ref","in":"query","schema":{"type":"string"}},{"name":"reference","in":"query","description":"Allows searching by reference","schema":{"type":"string"}},{"name":"embed","in":"query","description":"A comma seperated list of resources to embed. Available: company, child_services, images","schema":{"type":"string"}},{"name":"category_id","in":"query","description":"Category id","schema":{"type":"integer","format":"int32"}},{"name":"availability","in":"query","description":"Valid Statuses: 0 - Appointment based services,1 - One off or regular events and courses,4 - Queue only services","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["0","1","4"]}}},{"name":"queuing_disabled","in":"query","description":"Filter queueable services","schema":{"type":"boolean"}},{"name":"person_id","in":"query","description":"Person id","schema":{"type":"string"}},{"name":"visibility_types","in":"query","description":"Filter service with different visibility_types","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["public","private","private_and_personal_booking_link"]}}}],"responses":{"200":{"description":"Services","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceCollection"}}}}}}},"/{company_id}/resources/{id}":{"get":{"tags":["Resource"],"summary":"Get Resource","description":"Retrieves a bookable resource.","operationId":"getCompanyIdResourcesId","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Resource ID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Get Resource","content":{}}}}},"/{company_id}/resources/find_by_ref/{reference}":{"get":{"tags":["Resource"],"summary":"Resource Find By Reference","description":"Retrieves a bookable resource.","operationId":"getCompanyIdResourcesFindByRefReference","parameters":[{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"string"}},{"name":"reference","in":"path","description":"Resource Integer id or String name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}}}}},"/{company_id}/resources":{"get":{"tags":["Resource"],"summary":"List Resources","description":"Retrieves a list of bookable resources.\nResults are returned as a paginated list.","operationId":"getCompanyIdResources","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":1000}},{"name":"reference","in":"query","description":"the API reference of the resource","schema":{"type":"string"}},{"name":"embed","in":"query","description":"A comma seperated list of resources to embed. Available: images","schema":{"type":"string"}}],"responses":{"200":{"description":"Resource Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceCollection"}}}}}}},"/company/find_by_ref/{ref}":{"get":{"tags":["Company"],"summary":"Find Company By Reference","description":"Retrieves a company that has a particular reference ID.","operationId":"getCompanyFindByRefRef","parameters":[{"name":"ref","in":"path","description":"Your reference id for the person","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Company","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}}}}},"/company/{company_id}/search":{"get":{"tags":["Company"],"summary":"Company Search","description":"Search for child companies.","operationId":"getCompanyCompanyIdSearch","parameters":[{"name":"strategy","in":"query","description":"Indicate how it searches company tree\nDefault strategy leafs to consist with current behaviour\nleafs: returns all leaf companies (companies have no children), in GP-P-C structure, this returns only C\nchildren: returns only children companies, in GP-P-C structure, this returns only P\ndescendants: returns all descendant companies in the hierarchy tree, in GP-P-C structure, this returns P and C","schema":{"type":"string","default":"leafs","enum":["leafs","children","descendants"]}},{"name":"include_self","in":"query","description":"Indicate if response includes current company","schema":{"type":"boolean"}},{"name":"company[text]","in":"query","description":"Company name, description or reference","schema":{"type":"string"}},{"name":"company[company_type]","in":"query","description":"Company type, physical (default) or virtual","schema":{"type":"string","enum":["physical","virtual"]}},{"name":"address[lat]","in":"query","description":"Address latitude","required":true,"schema":{"type":"string"}},{"name":"address[long]","in":"query","description":"Address longitude","required":true,"schema":{"type":"string"}},{"name":"address[radius]","in":"query","description":"Address Search radius(km)","schema":{"type":"integer","format":"int32"}},{"name":"service_id","in":"query","description":"A parent-level ID of a service which the companies provide","schema":{"type":"integer","format":"int32"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":30}},{"name":"enabled_only","in":"query","description":"Only return companies that are not disabled","schema":{"type":"boolean"}},{"name":"person_id","in":"query","description":"Filter based on Person","schema":{"type":"integer","format":"int32"}},{"name":"filter_disabled_services","in":"query","description":"Filter out companies where services are disabled","schema":{"type":"boolean"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Company Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCollection"}}}}}}},"/company/{company_id}/children":{"get":{"tags":["Company"],"summary":"List Child Companies","description":"Retrieves a list of child companies for a parent company.","operationId":"getCompanyCompanyIdChildren","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":30}},{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"string"}},{"name":"live","in":"query","description":"Include, or exclude non-live companies","schema":{"type":"boolean"}},{"name":"service_id","in":"query","description":"A parent-level ID of a service which the companies provide","schema":{"type":"integer","format":"int32"}},{"name":"person_id","in":"query","description":"Person Id","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Company Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCollection"}}}}}}},"/company/{company_id}":{"get":{"tags":["Company"],"summary":"Get Company","description":"Retrieves a company.","operationId":"getCompanyCompanyId","parameters":[{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Company with the given ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}}}}},"/{company_id}/events/{id}":{"get":{"tags":["Event"],"summary":"Get Event","description":"Retrieves a bookable event.","operationId":"getCompanyIdEventsId","parameters":[{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Event id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"embed","in":"query","description":"A comma seperated list of resources to embed. Available: person","schema":{"type":"string"}}],"responses":{"200":{"description":"Event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}}}}},"/{company_id}/events":{"get":{"tags":["Event"],"summary":"List Events","description":"Retrieves a list of bookable events.","operationId":"getCompanyIdEvents","parameters":[{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"string"}},{"name":"start_date","in":"query","description":"Start Date in ISO-8601","schema":{"type":"string"}},{"name":"end_date","in":"query","description":"End Date in ISO-8601","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"event_group_id","in":"query","description":"An Event Group ID","schema":{"type":"integer","format":"int32"}},{"name":"event_chain_id","in":"query","description":"An Event Chain ID","schema":{"type":"integer","format":"int32"}},{"name":"resource_id","in":"query","description":"A Person ID","schema":{"type":"integer","format":"int32"}},{"name":"person_id","in":"query","description":"A Resource ID","schema":{"type":"integer","format":"int32"}},{"name":"address_id","in":"query","description":"An Address ID","schema":{"type":"integer","format":"int32"}},{"name":"summary","in":"query","schema":{"type":"boolean"}},{"name":"include_non_bookable","in":"query","schema":{"type":"boolean"}},{"name":"embed","in":"query","description":"A comma seperated list of resources to embed. Available: person","schema":{"type":"string"}},{"name":"modified_since","in":"query","description":"Only get events updated since a certain ISO8601 date/time","schema":{"type":"string"}},{"name":"filter_by[date]","in":"query","description":"Specific date","schema":{"type":"string","format":"date"}},{"name":"filter_by[answer]","in":"query","description":"Answer to a specific business question","schema":{"type":"string"}},{"name":"order_by[name]","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"order_by[date]","in":"query","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"Event Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventCollection"}}}}}}},"/{company_id}/events/search":{"get":{"tags":["Events"],"summary":"Returns list of events with filtering capability based on startdate enddate and location","description":"Searches and filters for events of a company. It will return a list of events of the parent and child locations,\nif the companyId is of the parent location, and it will return only child location events if the given companyId\nis of the child location.","operationId":"getCompanyIdEventsSearch","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"start_date","in":"query","description":"Event start date (YYYY-MM-DD)","required":true,"schema":{"type":"string","format":"date"}},{"name":"start_time","in":"query","description":"Start time. 24 hour clock. Format: HH:mm. Start date is required.","schema":{"type":"string"}},{"name":"end_date","in":"query","description":"Event end date (YYYY-MM-DD)","required":true,"schema":{"type":"string","format":"date"}},{"name":"end_time","in":"query","description":"End time. 24 hour clock. Format: HH:mm. End date is required.","schema":{"type":"string"}},{"name":"event_group_id","in":"query","description":"Event group id","schema":{"type":"integer","format":"int32"}},{"name":"address[lat]","in":"query","description":"Address latitude","required":true,"schema":{"type":"string"}},{"name":"address[long]","in":"query","description":"Address longitude","required":true,"schema":{"type":"string"}},{"name":"address[radius]","in":"query","description":"Address Search radius(km)","schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","description":"Number of items per page","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Event search","content":{}},"404":{"description":"Not Found","content":{}}}}},"/{company_id}/event_groups/{id}":{"get":{"tags":["Event Group"],"summary":"Get Event Group","description":"Retrieves a event group.","operationId":"getCompanyIdEventGroupsId","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Service id or name","required":true,"schema":{"type":"string"}},{"name":"embed","in":"query","description":"A comma seperated list of resources to embed. Available: images","schema":{"type":"string"}}],"responses":{"200":{"description":"Event Group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGroup"}}}}}}},"/{company_id}/event_groups/find_by_ref/{reference}":{"get":{"tags":["Event Group"],"summary":"EventGroup Find By Reference","description":"Retrieves an event_group by reference.","operationId":"getCompanyIdEventGroupsFindByRefReference","parameters":[{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"string"}},{"name":"reference","in":"path","description":"EventGroup Integer id or String name","required":true,"schema":{"type":"string"}},{"name":"embed","in":"query","description":"A comma seperated list of resources to embed. Available: company, child_services, images","schema":{"type":"string"}}],"responses":{"200":{"description":"EventGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGroup"}}}}}}},"/{company_id}/event_groups":{"get":{"tags":["Event Group"],"summary":"List Event Groups","description":"Retrieves a list of event groups.\nResults are returned as a paginated list.","operationId":"getCompanyIdEventGroups","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":200}},{"name":"reference","in":"query","description":"Allows searching by reference","schema":{"type":"string"}},{"name":"embed","in":"query","description":"A comma seperated list of resources to embed. Available: images","schema":{"type":"string"}}],"responses":{"200":{"description":"Event Group Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventGroupCollection"}}}}}}},"/{company_id}/event_chains/{id}":{"get":{"tags":["Event Chain"],"summary":"Get Event Chain","description":"Retrieves an event chain.","operationId":"getCompanyIdEventChainsId","parameters":[{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Event Chain id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Event Chain","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventChain"}}}}}}},"/{company_id}/event_chains":{"get":{"tags":["Event Chain"],"summary":"List Event Chains","description":"Retrieves a list of event chains.","operationId":"getCompanyIdEventChains","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":100}},{"name":"start_date","in":"query","description":"Start Date in ISO-8601 - show chains ending after this date","schema":{"type":"string"}},{"name":"end_date","in":"query","description":"End Date in ISO-8601 - show chains beginning before this date","schema":{"type":"string"}},{"name":"address_id","in":"query","description":"An Address ID","schema":{"type":"integer","format":"int32"}},{"name":"event_group_id","in":"query","description":"An event group","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Event Chain Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventChainCollection"}}}}}}},"/{company_id}/questions/{id}":{"get":{"tags":["Question"],"summary":"Get Question","description":"Retrieves question.","operationId":"getCompanyIdQuestionsId","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Question","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Question"}}}},"403":{"description":"Forbidden","content":{}}}}},"/{company_id}/questions":{"get":{"tags":["Question"],"summary":"Get Question Group","description":"Retrieves question group.","operationId":"getCompanyIdQuestions","parameters":[{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"string"}},{"name":"detail_group_id","in":"query","description":"Detail Group id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"include_hidden_questions","in":"query","description":"Returns the hidden questions along with non admin questions for public joureny","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Get Question Group","content":{}}}}},"/{company_id}/{detail_group_id}/survey_questions":{"get":{"tags":["Question"],"summary":"List Survey Question","description":"Retrieves a list of survey questions for a service.\nResults are returned as a group of questions for a specific question group.","operationId":"getCompanyIdDetailGroupIdSurveyQuestions","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"detail_group_id","in":"path","description":"Detail Group ID","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"admin_only","in":"query","description":"Determines whether or not to return admin only questions or not","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Question Group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuestionGroup"}}}}}}},"/{company_id}/categories/{id}":{"get":{"tags":["Category"],"summary":"Get Category","description":"Retrieves a category.","operationId":"getCompanyIdCategoriesId","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Category ID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Category","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"404":{"description":"Not Found","content":{}}}}},"/{company_id}/categories":{"get":{"tags":["Category"],"summary":"List Categories","description":"Retrieves a list of categories.","operationId":"getCompanyIdCategories","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"active","in":"query","description":"To filter active and inactive categories","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Category Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryCollection"}}}},"404":{"description":"Not Found","content":{}}}}},"/{company_id}/named_categories":{"get":{"tags":["Category"],"summary":"List Named Categories","description":"Retrieves a list of categories.","operationId":"getCompanyIdNamedCategories","parameters":[{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"string"}},{"name":"active","in":"query","description":"To filter active and inactive categories","schema":{"type":"boolean"}},{"name":"person_id","in":"query","description":"Person id","schema":{"type":"string"}}],"responses":{"200":{"description":"Named Category Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryLocalNameCollection"}}}}}}},"/{company_id}/client/{id}":{"get":{"tags":["Client"],"summary":"Client Read","description":"Retrieves a client.","operationId":"getCompanyIdClientId","parameters":[{"name":"id","in":"path","description":"ID can't be blank.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Client","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}}}}},"put":{"tags":["Client"],"summary":"Update Client","description":"Updates a client.\nYou must be logged in as this client to update their details via the public API.","operationId":"putCompanyIdClientId","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/putCompanyIdClient"}}},"required":true},"responses":{"200":{"description":"Client","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}}}},"x-codegen-request-body-name":"CompanyIdClient"}},"/{company_id}/client/find_by_email/{email}":{"get":{"tags":["Client"],"summary":"Find Client By Email","description":"Search for a client using their email address and company_id","operationId":"getCompanyIdClientFindByEmailEmail","parameters":[{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"string"}},{"name":"email","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Client","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}}}}}},"/{company_id}/client":{"post":{"tags":["Client"],"summary":"Create Client","description":"Creates a new client.","operationId":"postCompanyIdClient","parameters":[{"name":"company_id","in":"path","description":"Company id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postCompanyIdClient"}}},"required":true},"responses":{"200":{"description":"Client","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}}}},"x-codegen-request-body-name":"CompanyIdClient"}},"/{company_id}/booking_text":{"get":{"tags":["Booking Text"],"summary":"List Booking Text","description":"Retrieves a list of booking text.\nCustom Booking Text is extra business text that should be shown in\ncertain circumstances.\nThis can be before a booking is made for a specific service, person\nor resource, or afterwards in the confirmation page","operationId":"getCompanyIdBookingText","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Booking Text Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingTextCollection"}}}}}}},"/{company_id}/addresses/search":{"post":{"tags":["Address"],"summary":"Search Address","description":"Search for an address.\nFind a matching address or addresses by a name or other properties.","operationId":"postCompanyIdAddressesSearch","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Address name"},"page":{"type":"integer","format":"int32","default":1},"per_page":{"type":"integer","format":"int32","default":30}}}}}},"responses":{"200":{"description":"Address Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressCollection"}}}}}}},"/{company_id}/addresses/{id}":{"get":{"tags":["Address"],"summary":"Get Address","description":"Retrieves an address.","operationId":"getCompanyIdAddressesId","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Address id, required","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Address","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}}}}},"/{company_id}/addresses":{"get":{"tags":["Address"],"summary":"List Addresses","description":"Retrieves a list of addresses.\nThis is a list of company branch/store/resource addresses, not client addresses.\nResults are returned as a paginated list","operationId":"getCompanyIdAddresses","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":30}}],"responses":{"200":{"description":"Address Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressCollection"}}}}}}},"/{company_id}/images/{id}":{"get":{"tags":["Image"],"summary":"Get Image","description":"Retrieves an image.","operationId":"getCompanyIdImagesId","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Image","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Image"}}}},"404":{"description":"Not Found","content":{}}}}},"/{company_id}/images":{"get":{"tags":["Image"],"summary":"List Images","description":"Retrieves a list of images.","operationId":"getCompanyIdImages","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"service_id","in":"query","description":"Service ID","schema":{"type":"integer","format":"int32"}},{"name":"resource_id","in":"query","description":"Resource ID","schema":{"type":"integer","format":"int32"}},{"name":"person_id","in":"query","description":"Person ID","schema":{"type":"integer","format":"int32"}},{"name":"category_id","in":"query","description":"Category (Service Category) ID","schema":{"type":"integer","format":"int32"}},{"name":"event_chain_id","in":"query","description":"Event Chain ID","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Image Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageCollection"}}}}}}},"/{company_id}/media/event_group_images/{event_group_id}/{id}":{"get":{"tags":["Image"],"summary":"Get Event Group Image","description":"Retrieves an image attached to an event group.","operationId":"getCompanyIdMediaEventGroupImagesEventGroupIdId","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"event_group_id","in":"path","description":"Event Group ID","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"id","in":"path","description":"Image ID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Image","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Image"}}}},"404":{"description":"Not Found","content":{}}}}},"/{company_id}/media/event_group_images/{event_group_id}":{"get":{"tags":["Image"],"summary":"List Event Group Images","description":"Get a list of images attached to an event group.","operationId":"getCompanyIdMediaEventGroupImagesEventGroupId","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"event_group_id","in":"path","description":"Event Group ID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Image Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageCollection"}}}}}}},"/{company_id}/packages/{id}":{"get":{"tags":["Package"],"summary":"Get Package","description":"Retrieves a package.","operationId":"getCompanyIdPackagesId","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Package ID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Get Package","content":{}}}}},"/{company_id}/packages":{"get":{"tags":["Package"],"summary":"List Packages","description":"Retrieves a list of packages.","operationId":"getCompanyIdPackages","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List Packages","content":{}}}}},"/{company_id}/bulk_purchases/{id}":{"get":{"tags":["Bulk Purchase"],"summary":"Get Bulk Purchase","description":"Retrieve a bulk purchase.","operationId":"getCompanyIdBulkPurchasesId","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Bulk Purchase ID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Bulk Purchase","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkPurchase"}}}}}}},"/{company_id}/bulk_purchases":{"get":{"tags":["Bulk Purchase"],"summary":"List Bulk Purchases","description":"Retrieve a list of bulk purchases.","operationId":"getCompanyIdBulkPurchases","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"created_since","in":"query","description":"Created since date in ISO-8601 (YYYY-MM-DD hh:mm)","schema":{"type":"string","format":"date-time"}},{"name":"modified_since","in":"query","description":"Modified since date in ISO-8601 (YYYY-MM-DD hh:mm)","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Bulk Purchase Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkPurchaseCollection"}}}}}}},"/{company_id}/bookings":{"post":{"tags":["Booking"],"summary":"Create Booking","description":"Creates a single booking without requiring admin permissions. This is a basic API that\nonly allows creating a purchase with a single item. Use the basket APIs if booking\nmultiple items or if the there is a need to hold the time slot before the client\ncompletes the booking.","operationId":"postCompanyIdBookings","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postCompanyIdBookings"}}},"required":true},"responses":{"201":{"description":"Booking","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Booking"}}}}},"x-codegen-request-body-name":"CompanyIdBookings"}},"/{company_id}/terminology":{"get":{"tags":["Terminology"],"summary":"Terminology Read","description":"Gets the defined terminology of the organization.\nFor example: In a hospital, the staff would be Doctors.\nResource might be hospital beds.","operationId":"getCompanyIdTerminology","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Terminology Read","content":{}}}}},"/event/{id}/landing_page":{"get":{"tags":["Event Landing Page"],"summary":"Fetch Event Landing Page","description":"Fetch Event Landing Page Configuration","operationId":"getEventIdLandingPage","parameters":[{"name":"id","in":"path","description":"Event ID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionLandingPage"}}}},"404":{"description":"Not Found","content":{}}}}},"/event/{id}":{"get":{"tags":["Event Detail"],"summary":"Fetch Event Detail","description":"Fetch Detail","operationId":"getEventId","parameters":[{"name":"id","in":"path","description":"Event ID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventChain"}}}},"404":{"description":"Not Found","content":{}}}}},"/{company_id}/people/find_by_ref":{"post":{"tags":["Person"],"summary":"Find Person By Reference ID","description":"Retrieves a bookable person that has a particular reference ID.","operationId":"postCompanyIdPeopleFindByRef","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string","description":"Your reference id for the person"},"embed":{"type":"string","description":"A comma seperated list of resources to embed. Available: images"}}}}},"required":true},"responses":{"200":{"description":"Person","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}}},"404":{"description":"Not Found","content":{}}}}},"/{company_id}/people/find_by_ref/{ref}":{"get":{"tags":["Person"],"summary":"Find Person By Reference ID","description":"Retrieves a bookable person that has a particular reference ID.","operationId":"getCompanyIdPeopleFindByRefRef","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"ref","in":"path","description":"Your reference id for the person","required":true,"schema":{"type":"string"}},{"name":"embed","in":"query","description":"A comma seperated list of resources to embed. Available: images","schema":{"type":"string"}}],"responses":{"200":{"description":"Person","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}}},"404":{"description":"Not Found","content":{}}}}},"/{company_id}/people/{id}":{"get":{"tags":["Person"],"summary":"Get Person","description":"Retrieves a bookable person.","operationId":"getCompanyIdPeopleId","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Person id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"embed","in":"query","description":"A comma seperated list of resources to embed. Available: images","schema":{"type":"string"}}],"responses":{"200":{"description":"Person","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}}}}},"/{company_id}/people":{"get":{"tags":["Person"],"summary":"List People","description":"Retrieves a list of bookable people.\nResults are returned in a paginated list.","operationId":"getCompanyIdPeople","parameters":[{"name":"company_id","in":"path","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":1000}},{"name":"embed","in":"query","description":"A comma seperated list of resources to embed. Available: images","schema":{"type":"string"}}],"responses":{"200":{"description":"Person Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonCollection"}}}}}}},"/booking_links":{"get":{"tags":["booking_links"],"description":"Get a single booking link by link_token","operationId":"getBookingLinks","parameters":[{"name":"link_token","in":"query","description":"Booking link token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get a single booking link by link_token","content":{}}}}},"/{company_id}/times/{datetime}":{"get":{"tags":["Time"],"description":"Read Time","operationId":"getCompanyIdTimesDatetime","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"datetime","in":"path","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"service_id","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"ignore_booking","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"person_id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"resource_id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"duration","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"assets[company_rule]","in":"query","description":"This asset must be on a company matching a rule. Valid values: 'default', 'any', Array<CompanyID>","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"assets[person_rule]","in":"query","description":"This asset must book a person matching a rule. Valid values: 'any', 'any_or_none', Array<PersonID>","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"assets[resource_rule]","in":"query","description":"This asset must book a resource matching a rule. Valid values: 'any', 'any_or_none', Array<ResourceID>","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"assets[pre_time]","in":"query","description":"Pre Time. Overrides service configuration","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32","enum":[0,5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100,105,110,115,120,125,130,135,140,145,150,155,160,165,170,175,180,185,190,195,200,205,210,215,220,225,230,235,240,245,250,255,260,265,270,275,280,285,290,295,300,305,310,315,320,325,330,335,340,345,350,355,360,365,370,375,380,385,390,395,400,405,410,415,420,425,430,435,440,445,450,455,460,465,470,475,480,485,490,495,500,505,510,515,520,525,530,535,540,545,550,555,560,565,570,575,580,585,590,595,600,605,610,615,620,625,630,635,640,645,650,655,660,665,670,675,680,685,690,695,700,705,710,715,720,725,730,735,740,745,750,755,760,765,770,775,780,785,790,795,800,805,810,815,820,825,830,835,840,845,850,855,860,865,870,875,880,885,890,895,900,905,910,915,920,925,930,935,940,945,950,955,960,965,970,975,980,985,990,995,1000,1005,1010,1015,1020,1025,1030,1035,1040,1045,1050,1055,1060,1065,1070,1075,1080,1085,1090,1095,1100,1105,1110,1115,1120,1125,1130,1135,1140,1145,1150,1155,1160,1165,1170,1175,1180,1185,1190,1195,1200,1205,1210,1215,1220,1225,1230,1235,1240,1245,1250,1255,1260,1265,1270,1275,1280,1285,1290,1295,1300,1305,1310,1315,1320,1325,1330,1335,1340,1345,1350,1355,1360,1365,1370,1375,1380,1385,1390,1395,1400,1405,1410,1415,1420,1425,1430,1435,1440]}}},{"name":"assets[post_time]","in":"query","description":"Post Time. Overrides service configuration","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32","enum":[0,5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100,105,110,115,120,125,130,135,140,145,150,155,160,165,170,175,180,185,190,195,200,205,210,215,220,225,230,235,240,245,250,255,260,265,270,275,280,285,290,295,300,305,310,315,320,325,330,335,340,345,350,355,360,365,370,375,380,385,390,395,400,405,410,415,420,425,430,435,440,445,450,455,460,465,470,475,480,485,490,495,500,505,510,515,520,525,530,535,540,545,550,555,560,565,570,575,580,585,590,595,600,605,610,615,620,625,630,635,640,645,650,655,660,665,670,675,680,685,690,695,700,705,710,715,720,725,730,735,740,745,750,755,760,765,770,775,780,785,790,795,800,805,810,815,820,825,830,835,840,845,850,855,860,865,870,875,880,885,890,895,900,905,910,915,920,925,930,935,940,945,950,955,960,965,970,975,980,985,990,995,1000,1005,1010,1015,1020,1025,1030,1035,1040,1045,1050,1055,1060,1065,1070,1075,1080,1085,1090,1095,1100,1105,1110,1115,1120,1125,1130,1135,1140,1145,1150,1155,1160,1165,1170,1175,1180,1185,1190,1195,1200,1205,1210,1215,1220,1225,1230,1235,1240,1245,1250,1255,1260,1265,1270,1275,1280,1285,1290,1295,1300,1305,1310,1315,1320,1325,1330,1335,1340,1345,1350,1355,1360,1365,1370,1375,1380,1385,1390,1395,1400,1405,1410,1415,1420,1425,1430,1435,1440]}}},{"name":"assets[person_group_id]","in":"query","description":"Person Group ID. This will overwrite the person_rule","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"assets[resource_group_id]","in":"query","description":"Resource Group ID. This will overwrite the resource_rule","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"Start Time","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Time"}}}}}}},"/{company_id}/times":{"get":{"tags":["Time"],"summary":"List Times","description":"Get a list of available booking start times for a particular day.\nThe available durations and prices are included under each start time.\nIf person_id and resource_id are not specified and the service has multiple people or\nresources (as specified by the who/what/where config), times that are the same but differ by\nperson or resource are merged together by default. If booking a particular person or\nresource either pass in their IDs in the person_id and resource_id params or pass the\nmerge_times param as false.\nRequested Assets (`requested_assets`), this parameters describe a list of rules which a time must\nsatisfy to be considered available.\nA Requested asset consists of a\n* company_rule -> can be either `default` (it will respect the company of the URL), `any` (it can be any company that provides the service), or `Array<CompanyID>` one of these companies (which must provide the service).\n* person_rule -> can be either `any` (any person which provides the service), `any_or_none` (the user is indifferent as to whether a person is associated to the booking), `Array<PersonID>` one of these people who provide the service.\n* resource_rule -> same as person_rule:  can be either `any` (any resource which provides the service), `any_or_none` (the user is indifferent as to whether a resource is associated to the booking), `Array<PersonID>` one of these resources with which the service can be provided.\nFactors that influence availability include:\n* Service, Person and Resource schedules\n* Bookings and blocked time\n* Company opening hours\n* Max/min advance\n* Min/max consecutive bookings (fixed time service)\n* Durations (flex time service)\n* Travel time (flex time service)\n* Booking time step","operationId":"getCompanyIdTimes","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"service_id","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"person_id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"resource_id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"start_date","in":"query","description":"Start Date in ISO-8601 format: %Y-%m-%d","required":true,"schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"End Date in ISO-8601 format: %Y-%m-%d","schema":{"type":"string","format":"date"}},{"name":"time_zone","in":"query","description":"Show times in a different time zone than the company","schema":{}},{"name":"only_available","in":"query","description":"Only show bookable start times","schema":{"type":"boolean"}},{"name":"ignore_booking","in":"query","description":"The ID of an existing booking to ignore - which will remove the associated slots from availability search","schema":{"type":"integer","format":"int32"}},{"name":"duration","in":"query","description":"Desired duration of the appointment, in minutes","schema":{"type":"integer","format":"int32"}},{"name":"pre_time","in":"query","description":"Pre Time. Overrides service configuration","schema":{"type":"integer","format":"int32","enum":[0,5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100,105,110,115,120,125,130,135,140,145,150,155,160,165,170,175,180,185,190,195,200,205,210,215,220,225,230,235,240,245,250,255,260,265,270,275,280,285,290,295,300,305,310,315,320,325,330,335,340,345,350,355,360,365,370,375,380,385,390,395,400,405,410,415,420,425,430,435,440,445,450,455,460,465,470,475,480,485,490,495,500,505,510,515,520,525,530,535,540,545,550,555,560,565,570,575,580,585,590,595,600,605,610,615,620,625,630,635,640,645,650,655,660,665,670,675,680,685,690,695,700,705,710,715,720,725,730,735,740,745,750,755,760,765,770,775,780,785,790,795,800,805,810,815,820,825,830,835,840,845,850,855,860,865,870,875,880,885,890,895,900,905,910,915,920,925,930,935,940,945,950,955,960,965,970,975,980,985,990,995,1000,1005,1010,1015,1020,1025,1030,1035,1040,1045,1050,1055,1060,1065,1070,1075,1080,1085,1090,1095,1100,1105,1110,1115,1120,1125,1130,1135,1140,1145,1150,1155,1160,1165,1170,1175,1180,1185,1190,1195,1200,1205,1210,1215,1220,1225,1230,1235,1240,1245,1250,1255,1260,1265,1270,1275,1280,1285,1290,1295,1300,1305,1310,1315,1320,1325,1330,1335,1340,1345,1350,1355,1360,1365,1370,1375,1380,1385,1390,1395,1400,1405,1410,1415,1420,1425,1430,1435,1440]}},{"name":"post_time","in":"query","description":"Post Time. Overrides service configuration","schema":{"type":"integer","format":"int32","enum":[0,5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100,105,110,115,120,125,130,135,140,145,150,155,160,165,170,175,180,185,190,195,200,205,210,215,220,225,230,235,240,245,250,255,260,265,270,275,280,285,290,295,300,305,310,315,320,325,330,335,340,345,350,355,360,365,370,375,380,385,390,395,400,405,410,415,420,425,430,435,440,445,450,455,460,465,470,475,480,485,490,495,500,505,510,515,520,525,530,535,540,545,550,555,560,565,570,575,580,585,590,595,600,605,610,615,620,625,630,635,640,645,650,655,660,665,670,675,680,685,690,695,700,705,710,715,720,725,730,735,740,745,750,755,760,765,770,775,780,785,790,795,800,805,810,815,820,825,830,835,840,845,850,855,860,865,870,875,880,885,890,895,900,905,910,915,920,925,930,935,940,945,950,955,960,965,970,975,980,985,990,995,1000,1005,1010,1015,1020,1025,1030,1035,1040,1045,1050,1055,1060,1065,1070,1075,1080,1085,1090,1095,1100,1105,1110,1115,1120,1125,1130,1135,1140,1145,1150,1155,1160,1165,1170,1175,1180,1185,1190,1195,1200,1205,1210,1215,1220,1225,1230,1235,1240,1245,1250,1255,1260,1265,1270,1275,1280,1285,1290,1295,1300,1305,1310,1315,1320,1325,1330,1335,1340,1345,1350,1355,1360,1365,1370,1375,1380,1385,1390,1395,1400,1405,1410,1415,1420,1425,1430,1435,1440]}},{"name":"assets[company_rule]","in":"query","description":"This asset must be on a company matching a rule. Valid values: 'default', 'any', Array<CompanyID>","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"assets[person_rule]","in":"query","description":"This asset must book a person matching a rule. Valid values: 'any', 'any_or_none', Array<PersonID>","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"assets[resource_rule]","in":"query","description":"This asset must book a resource matching a rule. Valid values: 'any', 'any_or_none', Array<ResourceID>","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"assets[pre_time]","in":"query","description":"Pre Time. Overrides service configuration","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32","enum":[0,5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100,105,110,115,120,125,130,135,140,145,150,155,160,165,170,175,180,185,190,195,200,205,210,215,220,225,230,235,240,245,250,255,260,265,270,275,280,285,290,295,300,305,310,315,320,325,330,335,340,345,350,355,360,365,370,375,380,385,390,395,400,405,410,415,420,425,430,435,440,445,450,455,460,465,470,475,480,485,490,495,500,505,510,515,520,525,530,535,540,545,550,555,560,565,570,575,580,585,590,595,600,605,610,615,620,625,630,635,640,645,650,655,660,665,670,675,680,685,690,695,700,705,710,715,720,725,730,735,740,745,750,755,760,765,770,775,780,785,790,795,800,805,810,815,820,825,830,835,840,845,850,855,860,865,870,875,880,885,890,895,900,905,910,915,920,925,930,935,940,945,950,955,960,965,970,975,980,985,990,995,1000,1005,1010,1015,1020,1025,1030,1035,1040,1045,1050,1055,1060,1065,1070,1075,1080,1085,1090,1095,1100,1105,1110,1115,1120,1125,1130,1135,1140,1145,1150,1155,1160,1165,1170,1175,1180,1185,1190,1195,1200,1205,1210,1215,1220,1225,1230,1235,1240,1245,1250,1255,1260,1265,1270,1275,1280,1285,1290,1295,1300,1305,1310,1315,1320,1325,1330,1335,1340,1345,1350,1355,1360,1365,1370,1375,1380,1385,1390,1395,1400,1405,1410,1415,1420,1425,1430,1435,1440]}}},{"name":"assets[post_time]","in":"query","description":"Post Time. Overrides service configuration","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32","enum":[0,5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100,105,110,115,120,125,130,135,140,145,150,155,160,165,170,175,180,185,190,195,200,205,210,215,220,225,230,235,240,245,250,255,260,265,270,275,280,285,290,295,300,305,310,315,320,325,330,335,340,345,350,355,360,365,370,375,380,385,390,395,400,405,410,415,420,425,430,435,440,445,450,455,460,465,470,475,480,485,490,495,500,505,510,515,520,525,530,535,540,545,550,555,560,565,570,575,580,585,590,595,600,605,610,615,620,625,630,635,640,645,650,655,660,665,670,675,680,685,690,695,700,705,710,715,720,725,730,735,740,745,750,755,760,765,770,775,780,785,790,795,800,805,810,815,820,825,830,835,840,845,850,855,860,865,870,875,880,885,890,895,900,905,910,915,920,925,930,935,940,945,950,955,960,965,970,975,980,985,990,995,1000,1005,1010,1015,1020,1025,1030,1035,1040,1045,1050,1055,1060,1065,1070,1075,1080,1085,1090,1095,1100,1105,1110,1115,1120,1125,1130,1135,1140,1145,1150,1155,1160,1165,1170,1175,1180,1185,1190,1195,1200,1205,1210,1215,1220,1225,1230,1235,1240,1245,1250,1255,1260,1265,1270,1275,1280,1285,1290,1295,1300,1305,1310,1315,1320,1325,1330,1335,1340,1345,1350,1355,1360,1365,1370,1375,1380,1385,1390,1395,1400,1405,1410,1415,1420,1425,1430,1435,1440]}}},{"name":"assets[person_group_id]","in":"query","description":"Person Group ID. This will overwrite the person_rule","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"assets[resource_group_id]","in":"query","description":"Resource Group ID. This will overwrite the resource_rule","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"Time Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeCollection"}}}},"400":{"description":"Bad Request","content":{}},"404":{"description":"Not Found","content":{}}}}},"/{company_id}/dates":{"get":{"tags":["Time"],"summary":"List Dates","description":"Get a list of available dates in which bookings can occur\nThe amount of times left available on each day are specified\nIf person_id and resource_id are not specified and the service has multiple people\nor resources (as specified by the who/what/where config), it will count the times\nfor any given date","operationId":"getCompanyIdDates","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"service_id","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"person_id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"resource_id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"start_date","in":"query","description":"Start Date in ISO-8601 format: %Y-%m-%d","required":true,"schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"End Date in ISO-8601 format: %Y-%m-%d","schema":{"type":"string","format":"date"}},{"name":"time_zone","in":"query","description":"Show times in a different time zone than the company","schema":{}},{"name":"only_available","in":"query","description":"Only show bookable start times","schema":{"type":"boolean"}},{"name":"ignore_booking","in":"query","description":"The ID of an existing booking to ignore - which will remove the associated slots from availability search","schema":{"type":"integer","format":"int32"}},{"name":"duration","in":"query","description":"Desired duration of the appointment, in minutes","schema":{"type":"integer","format":"int32"}},{"name":"assets[company_rule]","in":"query","description":"This asset must be on a company matching a rule. Valid values: 'default', 'any', Array<CompanyID>","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"assets[person_rule]","in":"query","description":"This asset must book a person matching a rule. Valid values: 'any', 'any_or_none', Array<PersonID>","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"assets[resource_rule]","in":"query","description":"This asset must book a resource matching a rule. Valid values: 'any', 'any_or_none', Array<ResourceID>","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"assets[pre_time]","in":"query","description":"Pre Time. Overrides service configuration","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32","enum":[0,5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100,105,110,115,120,125,130,135,140,145,150,155,160,165,170,175,180,185,190,195,200,205,210,215,220,225,230,235,240,245,250,255,260,265,270,275,280,285,290,295,300,305,310,315,320,325,330,335,340,345,350,355,360,365,370,375,380,385,390,395,400,405,410,415,420,425,430,435,440,445,450,455,460,465,470,475,480,485,490,495,500,505,510,515,520,525,530,535,540,545,550,555,560,565,570,575,580,585,590,595,600,605,610,615,620,625,630,635,640,645,650,655,660,665,670,675,680,685,690,695,700,705,710,715,720,725,730,735,740,745,750,755,760,765,770,775,780,785,790,795,800,805,810,815,820,825,830,835,840,845,850,855,860,865,870,875,880,885,890,895,900,905,910,915,920,925,930,935,940,945,950,955,960,965,970,975,980,985,990,995,1000,1005,1010,1015,1020,1025,1030,1035,1040,1045,1050,1055,1060,1065,1070,1075,1080,1085,1090,1095,1100,1105,1110,1115,1120,1125,1130,1135,1140,1145,1150,1155,1160,1165,1170,1175,1180,1185,1190,1195,1200,1205,1210,1215,1220,1225,1230,1235,1240,1245,1250,1255,1260,1265,1270,1275,1280,1285,1290,1295,1300,1305,1310,1315,1320,1325,1330,1335,1340,1345,1350,1355,1360,1365,1370,1375,1380,1385,1390,1395,1400,1405,1410,1415,1420,1425,1430,1435,1440]}}},{"name":"assets[post_time]","in":"query","description":"Post Time. Overrides service configuration","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32","enum":[0,5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100,105,110,115,120,125,130,135,140,145,150,155,160,165,170,175,180,185,190,195,200,205,210,215,220,225,230,235,240,245,250,255,260,265,270,275,280,285,290,295,300,305,310,315,320,325,330,335,340,345,350,355,360,365,370,375,380,385,390,395,400,405,410,415,420,425,430,435,440,445,450,455,460,465,470,475,480,485,490,495,500,505,510,515,520,525,530,535,540,545,550,555,560,565,570,575,580,585,590,595,600,605,610,615,620,625,630,635,640,645,650,655,660,665,670,675,680,685,690,695,700,705,710,715,720,725,730,735,740,745,750,755,760,765,770,775,780,785,790,795,800,805,810,815,820,825,830,835,840,845,850,855,860,865,870,875,880,885,890,895,900,905,910,915,920,925,930,935,940,945,950,955,960,965,970,975,980,985,990,995,1000,1005,1010,1015,1020,1025,1030,1035,1040,1045,1050,1055,1060,1065,1070,1075,1080,1085,1090,1095,1100,1105,1110,1115,1120,1125,1130,1135,1140,1145,1150,1155,1160,1165,1170,1175,1180,1185,1190,1195,1200,1205,1210,1215,1220,1225,1230,1235,1240,1245,1250,1255,1260,1265,1270,1275,1280,1285,1290,1295,1300,1305,1310,1315,1320,1325,1330,1335,1340,1345,1350,1355,1360,1365,1370,1375,1380,1385,1390,1395,1400,1405,1410,1415,1420,1425,1430,1435,1440]}}},{"name":"assets[person_group_id]","in":"query","description":"Person Group ID. This will overwrite the person_rule","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"assets[resource_group_id]","in":"query","description":"Resource Group ID. This will overwrite the resource_rule","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"Date Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DateCollection"}}}},"400":{"description":"Bad Request","content":{}},"404":{"description":"Not Found","content":{}}}}},"/{company_id}/opening_hours":{"get":{"tags":["Opening Hours"],"summary":"Company Opening Hours","description":"Retrieves the opening hours for a company.","operationId":"getCompanyIdOpeningHours","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Company Opening Hours","content":{}}}}},"/{company_id}/company_text":{"get":{"tags":["Company Text"],"summary":"Company text configurations read","description":"Load configuration details for base company text","operationId":"getCompanyIdCompanyText","parameters":[{"name":"message_type","in":"query","description":"Message type","schema":{"type":"string","enum":["public_consent","admin_consent"]}},{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Company text configurations read","content":{}}}}},"/{company_id}/guest/{uuid}":{"get":{"tags":["Guest"],"summary":"Get Guest Details","description":"Retrieves guest details by UUID and Event ID including client details, questions,\nand timings. Both UUID and Event ID are required for security and accuracy.","operationId":"getCompanyIdGuestUuid","parameters":[{"name":"uuid","in":"path","description":"Guest UUID","required":true,"schema":{"type":"string"}},{"name":"event_id","in":"query","description":"Event ID","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"source_of_registration","in":"query","description":"Source of registration","schema":{"type":"string","default":"invitation","enum":["invitation","public_registration"]}},{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Guest Details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Guest"}}}},"404":{"description":"Guest Not Found","content":{}}}}}},"components":{"schemas":{"putCompanyIdClient":{"type":"object","properties":{"first_name":{"type":"string","description":"First name"},"first_name_extra":{"type":"string","description":"First name extra"},"last_name":{"type":"string","description":"Last name"},"last_name_extra":{"type":"string","description":"Last name extra"},"email":{"type":"string","description":"Email"},"mobile_prefix":{"type":"string","description":"Mobile prefix"},"mobile":{"type":"string","description":"Mobile phone"},"mobile_prefix_country_code":{"type":"string","description":"Mobile Prefix Country Code"},"phone_prefix":{"type":"string","description":"Phone prefix"},"phone":{"type":"string","description":"Phone"},"phone_prefix_country_code":{"type":"string","description":"Phone Prefix Country Code"},"address1":{"type":"string","description":"Address1"},"address2":{"type":"string","description":"Address2"},"address3":{"type":"string","description":"Address3"},"address4":{"type":"string","description":"Address4"},"address5":{"type":"string","description":"Address5"},"postcode":{"type":"string","description":"Postcode"},"country":{"type":"string","description":"Country"},"member_type":{"type":"integer","description":"Customer Type","format":"int32","enum":[1,2]},"member_level_id":{"type":"integer","description":"Member Level ID","format":"int32"},"mem_join_date":{"type":"string","description":"Client's Join Date in ISO-8601","format":"date"},"time_zone":{"type":"string","description":"Time zone"},"consent":{"type":"boolean","description":"Consent for collecting and storing data"},"extra_info":{"type":"object","properties":{"locale":{"type":"string","description":"Language locale"}}},"comp_ref":{"type":"string"},"default_company_id":{"type":"string","description":"The default company the client should belong to"},"notification_preferences":{"type":"object","properties":{"email":{"type":"object","properties":{"bookings":{"type":"boolean"}}},"sms":{"type":"object","properties":{"bookings":{"type":"boolean"}}}}}},"description":"Update Client"},"postCompanyIdClient":{"type":"object","properties":{"first_name":{"type":"string","description":"First name"},"first_name_extra":{"type":"string","description":"First name extra"},"last_name":{"type":"string","description":"Last name"},"last_name_extra":{"type":"string","description":"Last name extra"},"email":{"type":"string","description":"Email"},"mobile_prefix":{"type":"string","description":"Mobile prefix"},"mobile":{"type":"string","description":"Mobile phone"},"mobile_prefix_country_code":{"type":"string","description":"Mobile Prefix Country Code"},"phone_prefix":{"type":"string","description":"Phone prefix"},"phone":{"type":"string","description":"Phone"},"phone_prefix_country_code":{"type":"string","description":"Phone Prefix Country Code"},"address1":{"type":"string","description":"Address1"},"address2":{"type":"string","description":"Address2"},"address3":{"type":"string","description":"Address3"},"address4":{"type":"string","description":"Address4"},"address5":{"type":"string","description":"Address5"},"postcode":{"type":"string","description":"Postcode"},"country":{"type":"string","description":"Country"},"member_type":{"type":"integer","description":"Customer Type","format":"int32","enum":[1,2]},"member_level_id":{"type":"integer","description":"Member Level ID","format":"int32"},"mem_join_date":{"type":"string","description":"Client's Join Date in ISO-8601","format":"date"},"time_zone":{"type":"string","description":"Time zone"},"consent":{"type":"boolean","description":"Consent for collecting and storing data"},"extra_info":{"type":"object","properties":{"locale":{"type":"string","description":"Language locale"}}},"comp_ref":{"type":"string"},"default_company_id":{"type":"string","description":"The default company the client should belong to"},"password":{"type":"string","description":"If a password is set, this created a 'member' user"},"send_welcome_email":{"type":"boolean","description":"Send or don't send welcome email","default":true},"notification_preferences":{"type":"object","properties":{"email":{"type":"object","properties":{"bookings":{"type":"boolean"}}},"sms":{"type":"object","properties":{"bookings":{"type":"boolean"}}}}}},"description":"Create Client"},"postCompanyIdBookings":{"type":"object","properties":{"datetime":{"type":"string","description":"Start Time","format":"date-time"},"service_id":{"type":"integer","description":"Service ID","format":"int32"},"person_id":{"type":"integer","description":"Person ID","format":"int32"},"person_ids":{"type":"array","description":"Person IDs","items":{"type":"integer","format":"int32"}},"resource_id":{"type":"integer","description":"Resource ID","format":"int32"},"member_id":{"type":"integer","description":"Member ID","format":"int32"},"client":{"required":["email"],"type":"object","properties":{"first_name":{"type":"string","description":"First Name"},"first_name_extra":{"type":"string","description":"First name extra"},"last_name":{"type":"string","description":"Last Name"},"last_name_extra":{"type":"string","description":"Last name extra"},"email":{"type":"string","description":"Email"},"mobile_prefix":{"type":"string","description":"Mobile Prefix"},"mobile":{"type":"string","description":"Mobile Phone"},"phone_prefix":{"type":"string","description":"Phone Prefix"},"phone":{"type":"string","description":"Phone"},"address1":{"type":"string","description":"Address1"},"address2":{"type":"string","description":"Address2"},"address3":{"type":"string","description":"Address3"},"address4":{"type":"string","description":"Address4"},"address5":{"type":"string","description":"Address5"},"postcode":{"type":"string","description":"Postcode"},"country":{"type":"string","description":"Country"},"notification_preferences":{"type":"object","properties":{"email":{"type":"object","properties":{"bookings":{"type":"boolean"}}},"sms":{"type":"object","properties":{"bookings":{"type":"boolean"}}}}}}},"event_id":{"type":"integer","description":"Event ID","format":"int32"},"event_chain_id":{"type":"integer","description":"Event Chain ID","format":"int32"}},"description":"Create Booking"},"Service":{"type":"object","properties":{"id":{"type":"integer","example":198549},"category_id":{"type":"integer","example":90434},"name":{"type":"string","example":"Tennis Coaching"},"description":{"type":"string","example":"Teach how to play tennis"},"durations":{"type":"array","example":[30,60],"items":{"type":"integer"}},"prices":{"type":"array","example":[1000,1500],"items":{"type":"integer"}},"detail_group_id":{"type":"integer"},"colour":{"type":"string","example":"#FF0000"},"listed_durations":{"type":"array","example":[20,50],"items":{"type":"integer"}},"extra":{"type":"object","properties":{},"example":{"booking_question":"answer","multiple_choice":["choice1","choice2","choice3"]}},"booking_time_step":{"type":"integer"},"can_refund_automatically":{"type":"boolean","example":false},"is_event_group":{"type":"boolean","example":false},"api_ref":{"type":"string","example":"null"},"reference":{"type":"string","example":"null"},"type":{"type":"string","example":"null"},"group_id":{"type":"integer","example":30944},"deleted":{"type":"boolean","example":false},"queuing_disabled":{"type":"boolean","example":false},"queue_duration":{"type":"integer"},"company_id":{"type":"integer","example":40001},"duration_unit":{"type":"string","example":"null"},"min_advance_period":{"type":"integer"},"max_advance_period":{"type":"integer"},"min_cancel_period":{"type":"integer"},"booking_type_public":{"type":"string","example":"null"},"booking_type_member":{"type":"string","example":"null"},"booking_type":{"type":"integer"},"mbooking_type":{"type":"integer"},"min_bookings":{"type":"integer"},"max_bookings":{"type":"integer"},"method_of_appointment":{"type":"string","example":"null"},"groups":{"type":"array","items":{"type":"integer"},"example":null},"spaces":{"type":"integer"},"order":{"type":"integer"},"child_level_service":{"type":"boolean","example":false},"_embedded":{"type":"object","properties":{"company":{"$ref":"#/components/schemas/Company"},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"},"example":null}}},"membership_prices":{"type":"object","properties":{},"example":null},"global_id":{"type":"integer"},"availability":{"type":"integer"},"price":{"type":"integer"},"price_after":{"type":"integer"},"price_after_date":{"type":"string","example":"null"},"price_in_major_units":{"type":"number","example":100.98},"price_after_in_major_units":{"type":"number","example":100.98},"prices_in_major_units":{"type":"array","example":[100.98],"items":{"type":"number"}},"combine_resource_and_staff":{"type":"string","example":"null"},"visibility_type":{"type":"string","example":"null"},"disabled":{"type":"string","example":"null"}},"description":"              Retrieves a bookable service.\n              duration_unit may be minute, day, or week\n"},"ServiceCollection":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"services":{"type":"array","items":{"$ref":"#/components/schemas/Service"},"example":null}}},"total_entries":{"type":"integer"}},"description":"              Retrieves a list of bookable services.\n              Results are returned as a paginated list.\n              duration_unit may be minute, day, or week\n"},"Resource":{"type":"object","properties":{"id":{"type":"string","example":"null"},"name":{"type":"string","example":"null"},"reference":{"type":"string","example":"null"},"description":{"type":"string","example":"null"},"type":{"type":"string","example":"null"},"extra":{"type":"string","example":"null"},"max_price":{"type":"string","example":"null"},"min_price":{"type":"string","example":"null"},"group_id":{"type":"string","example":"null"},"deleted":{"type":"string","example":"null"},"disabled":{"type":"string","example":"null"},"company_id":{"type":"string","example":"null"},"email":{"type":"string","example":"null"},"order":{"type":"string","example":"null"},"address_id":{"type":"string","example":"null"},"max_book":{"type":"string","example":"null"},"_embedded":{"type":"object","properties":{"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"},"example":null}}}},"description":"              Retrieves a bookable resource.\n"},"ResourceCollection":{"type":"object","properties":{"total_entries":{"type":"integer"},"_embedded":{"type":"object","properties":{"resources":{"type":"array","items":{"$ref":"#/components/schemas/Resource"},"example":null}}}},"description":"              Retrieves a list of bookable resources.\n              Results are returned as a paginated list.\n"},"Company":{"type":"object","properties":{"id":{"type":"integer","example":37000},"name":{"type":"string","example":"Pet Store Ltd."},"description":{"type":"string","example":"Take care of pets"},"company_type":{"type":"string","example":"null"},"extra":{"type":"object","properties":{},"example":{"123":"answer to question 123","345":"answer to question 345"}},"address_id":{"type":"integer","example":958694},"website":{"type":"string","example":"petstore.london"},"multi_status":{"type":"string","example":"null"},"reference":{"type":"string","example":"null"},"numeric_widget_id":{"type":"integer"},"currency_code":{"type":"string","example":"GBP"},"timezone":{"type":"string","example":"BST"},"country_code":{"type":"string","example":"GB"},"live":{"type":"boolean","example":false},"ref":{"type":"string","example":"null"},"created_at":{"type":"string","example":"null"},"updated_at":{"type":"string","example":"null"},"children_count":{"type":"integer"},"locale":{"type":"string","example":"null"},"available_locales":{"type":"string","example":"null"},"membership_id":{"type":"integer","example":37000},"address":{"$ref":"#/components/schemas/Address"},"_embedded":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/CompanySettings"}}}},"description":"Retrieves a company.\n"},"CompanyCollection":{"type":"object","properties":{"total_entries":{"type":"integer"},"_embedded":{"type":"object","properties":{"companies":{"type":"array","items":{"$ref":"#/components/schemas/Company"},"example":null}}}},"description":"Retrieves a list of child companies for a parent company.\n"},"Event":{"type":"object","properties":{"id":{"type":"integer","example":11111},"updated_at":{"type":"string","example":"2017-08-17T16:30:27Z"},"datetime":{"type":"string","example":"2017-08-17T17:30:27Z"},"description":{"type":"string","example":"A description"},"status":{"type":"integer","example":4},"status_name":{"type":"string","example":"booked"},"spaces_booked":{"type":"integer","example":3},"spaces_reserved":{"type":"integer","example":4},"spaces_blocked":{"type":"integer","example":5},"spaces_held":{"type":"integer","example":6},"num_spaces":{"type":"integer","example":18},"spaces_wait":{"type":"integer","example":2},"event_chain_id":{"type":"integer","example":9348539},"person_id":{"type":"integer","example":341995},"resource_id":{"type":"integer","example":23888},"service_id":{"type":"integer","example":1112344},"duration":{"type":"integer","example":30},"price":{"type":"integer","example":2500},"ticket_spaces":{"type":"object","properties":{},"example":{"1":{"name":"Name 1","left":1},"2":{"name":"Name 2","left":1},"6":{"name":"Name 6","left":5}}},"units":{"type":"string","example":"minute|day|week"},"company_id":{"type":"integer","example":59305},"session_num":{"type":"integer","example":42},"bookable":{"type":"boolean","example":true},"modified_date":{"type":"string","example":"2017-09-27T17:30:27Z"},"detail_group_id":{"type":"integer"},"price_in_major_units":{"type":"string","example":"null"},"multi_day":{"type":"boolean","example":true},"end_datetime":{"type":"string","example":"2017-08-17T17:30:27Z"},"_embedded":{"type":"object","properties":{"person":{"$ref":"#/components/schemas/Person"},"images":{"type":"array","items":{"$ref":"#/components/schemas/GlobalImage"},"example":null}}}},"description":"              Retrieves a bookable event.\n"},"EventCollection":{"type":"object","properties":{"total_entries":{"type":"integer"},"_embedded":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"example":null}}}},"description":"              Retrieves a list of bookable events.\n"},"EventGroup":{"type":"object","properties":{"id":{"type":"integer","example":3234},"name":{"type":"string","example":"Name of event group"},"description":{"type":"string","example":"Description of the event group"},"colour":{"type":"string","example":"#800000"},"company_id":{"type":"integer","example":40001},"api_ref":{"type":"string","example":"REF123"},"reference":{"type":"string","example":"REF123"},"extra":{"type":"object","properties":{},"example":{"standard_question_1":"answer to question_1","checkbox_question_2":["option_1_for_question_2","option_2_for_question_2"]}},"_embedded":{"type":"object","properties":{"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"},"example":null}}}},"description":"              Retrieves an event_group by reference.\n"},"EventGroupCollection":{"type":"object","properties":{"total_entries":{"type":"integer","example":90},"_embedded":{"type":"object","properties":{"event_groups":{"type":"array","items":{"$ref":"#/components/schemas/EventGroup"},"example":null}}}},"description":"              Retrieves a list of event groups.\n              Results are returned as a paginated list.\n"},"EventChain":{"type":"object","properties":{"id":{"type":"integer","example":69855},"updated_at":{"type":"string","example":"2024-01-01T12:44:23Z"},"created_at":{"type":"string","example":"2024-01-01T12:44:23Z"},"name":{"type":"string","example":"Event Chain"},"description":{"type":"string","example":"A description"},"duration":{"type":"integer","example":34},"group":{"type":"string","example":"Name of service"},"time":{"type":"string","example":"2024-01-07T12:44:23Z"},"waitlength":{"type":"integer","example":60},"long_description":{"type":"string","example":"Detailed description"},"capacity_view":{"type":"integer","example":3},"start_date":{"type":"string","example":"2024-01-04"},"end_date":{"type":"string","example":"2024-01-07"},"spaces":{"type":"integer","example":1},"person_name":{"type":"string","example":"Dr. Carol Smilie"},"resource_name":{"type":"string","example":"Surgery Room 1"},"price":{"type":"integer","example":2000},"max_num_bookings":{"type":"integer","example":1},"max_advance_time":{"type":"string","example":"2024-01-04T13:14:23Z"},"min_advance_time":{"type":"string","example":"2024-02-01T12:44:23Z"},"min_advance":{"type":"integer","example":4},"min_advance_unit":{"type":"string","example":"minute"},"min_cancel":{"type":"integer","example":30},"min_cancel_unit":{"type":"string","example":"minute"},"ticket_type":{"type":"string","example":"multi_space"},"email_per_ticket":{"type":"boolean","example":true},"questions_per_ticket":{"type":"boolean","example":false},"extra":{"type":"object","properties":{},"example":{"question_1":"answer to question_1","checkbox_question":["possible answer 1","possible answer 2","possible answer 3"]}},"course":{"type":"boolean","example":true},"recurrence_type":{"type":"string","example":"WEEKLY"},"company_id":{"type":"integer","example":589345},"occurances":{"type":"integer","example":23},"price_in_major_units":{"type":"string","example":"null"},"invitation_only":{"type":"string","example":"null"},"_embedded":{"type":"object","properties":{"slots":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"example":null},"events":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"example":null},"ticket_sets":{"type":"array","example":{"name":"Name","type":"type","price":2700,"event_chain_id":50348,"id":9482948,"min_num_bookings":3,"max_num_bookings":30,"pool_name":"Pool Name","pool_id":3290485,"pool_description":"Description","valid_from":"2024-01-07","valid_to":"2024-02-22","spaces":30,"counts_as":"string","price_type_id":75862},"items":{"type":"object","properties":{}}},"questions":{"$ref":"#/components/schemas/QuestionGroup"},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"},"example":null}}}},"description":"              Retrieves an event chain.\n"},"EventChainCollection":{"type":"object","properties":{"total_entries":{"type":"integer","example":35},"_embedded":{"type":"object","properties":{"event_chains":{"type":"array","items":{"$ref":"#/components/schemas/EventChain"},"example":null}}}},"description":"              Retrieves a list of event chains.\n"},"Question":{"type":"object","properties":{"id":{"type":"integer","example":69556},"name":{"type":"string","example":"Name of The Question"},"position":{"type":"integer","example":3},"required":{"type":"boolean","example":false},"important":{"type":"boolean","example":true},"admin_only":{"type":"boolean","example":true},"applies_to":{"type":"integer"},"ask_member":{"type":"boolean","example":true},"detail_type":{"type":"string","example":"select-price"},"default":{"type":"string","example":"1"},"help_text":{"type":"string","example":"This relates to your current health"},"options":{"type":"object","properties":{},"example":[{"name":"Option 1","price":3200,"is_default":false,"id":95834},{"name":"Option 2","price":5200,"is_default":true,"id":584},{"name":"Option 3","price":7310,"is_default":false,"id":934}]},"settings":{"type":"object","properties":{},"example":{"conditional_question":"Question","conditional_answer":"Answer"}},"price":{"type":"number","example":8890},"price_per_booking":{"type":"boolean","example":true},"outcome":{"type":"boolean","example":false},"hide_on_customer_journey":{"type":"boolean","example":false}},"description":"              Retrieves question.\n"},"QuestionGroup":{"type":"object","properties":{"company_id":{"type":"integer","example":37001},"questions":{"$ref":"#/components/schemas/Question"},"name":{"type":"string","example":"Default group"}},"description":"            Retrieves a list of survey questions for a service.\n            Results are returned as a group of questions for a specific question group.\n"},"Category":{"type":"object","properties":{"id":{"type":"string","example":"null"},"parent_id":{"type":"string","example":"null"},"name":{"type":"string","example":"null"},"description":{"type":"string","example":"null"}},"description":"            Retrieves a category.\n"},"CategoryCollection":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"},"example":null}}}},"description":"            Retrieves a list of categories.\n"},"CategoryLocalNameCollection":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"string"},"example":null}}}},"description":"            Retrieves a list of categories.\n"},"Client":{"type":"object","properties":{"first_name":{"type":"string","example":"Ada"},"first_name_extra":{"type":"string","example":"null"},"last_name":{"type":"string","example":""},"last_name_extra":{"type":"string","example":"null"},"name":{"type":"string","example":"Ada Lovelace"},"email":{"type":"string","example":"ada.lovelace@email.com"},"address1":{"type":"string","example":"3-7 Herbal Hill"},"address2":{"type":"string","example":"Farringdon"},"address3":{"type":"string","example":"London"},"address4":{"type":"string","example":"Address Line 4"},"address5":{"type":"string","example":"Address Line 5"},"postcode":{"type":"string","example":"EC1R 5EJ"},"country":{"type":"string","example":"UK"},"phone":{"type":"string","example":"081-811-8181"},"mobile":{"type":"string","example":"293-482-342"},"phone_prefix":{"type":"string","example":"+44"},"phone_prefix_country_code":{"type":"string","example":"CA"},"mobile_prefix":{"type":"string","example":"+44"},"mobile_prefix_country_code":{"type":"string","example":"CA"},"id":{"type":"integer","example":54924},"answers":{"type":"object","properties":{},"example":[{"question_id":23,"name":"Question 1","answer":"Answer To Question 1"},{"question_id":88,"name":"Question 2","answer":"Answer To Question 2"},{"question_id":59,"name":"Question 3","answer":"Answer To Question 3"}]},"deleted":{"type":"boolean","example":true},"notifications":{"type":"object","properties":{},"example":{"1":"Notification 1","2":"Notification 2","3":"Notification 3"}},"client_type":{"type":"string","example":"Member|Contact"},"default_company_id":{"type":"integer","example":7859763},"reference":{"type":"string","example":"REF123"},"locale":{"type":"string","example":"UK"},"consent":{"type":"boolean","example":true},"time_zone":{"type":"string","example":"America/Los_Angeles"},"notification_preferences":{"type":"string","example":"null"}},"description":"Creates a new client.\n"},"BookingTextCollection":{"type":"object","properties":{"company_id":{"type":"string","example":"null"},"_embedded":{"type":"object","properties":{"booking_text":{"type":"array","items":{"type":"string"},"example":null}}}},"description":"            Retrieves a list of booking text.\n            Custom Booking Text is extra business text that should be shown in\n            certain circumstances.\n            This can be before a booking is made for a specific service, person\n            or resource, or afterwards in the confirmation page\n"},"AddressCollection":{"type":"object","properties":{"total_entries":{"type":"integer"},"_embedded":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"},"example":null}}}},"description":"Retrieves a list of addresses.\nThis is a list of company branch/store/resource addresses, not client addresses.\nResults are returned as a paginated list\n"},"Address":{"type":"object","properties":{"id":{"type":"integer","example":13101},"name":{"type":"string","example":"Company HQ"},"address1":{"type":"string","example":"2nd Floor"},"address2":{"type":"string","example":"3-7 Herbal Hill"},"address3":{"type":"string","example":"Farringdon"},"address4":{"type":"string","example":"London"},"address5":{"type":"string","example":"null"},"postcode":{"type":"string","example":"null"},"country":{"type":"string","example":"null"},"lat":{"type":"number","example":-0.1084389},"long":{"type":"number","example":51.5226634},"map_url":{"type":"string","example":"null"},"map_marker":{"type":"string","example":"null"},"phone":{"type":"string","example":"0203 123 4567"},"homephone":{"type":"string","example":"null"},"email":{"type":"string","example":"hi@bookingbug.com"},"workphone":{"type":"string","example":"null"},"pretty_workphone":{"type":"string","example":"null"},"extra":{"type":"object","properties":{},"example":{"simple_question":"Answer to question","checkbox_question":["choice1","choice2","choice3"]}}},"description":"              Retrieves an address.\n"},"Image":{"type":"object","properties":{"id":{"type":"string","example":"null"},"company_id":{"type":"string","example":"null"},"name":{"type":"string","example":"null"},"image_file_name":{"type":"string","example":"null"},"foreign_key":{"type":"string","example":"null"},"url":{"type":"string","example":"null"}},"description":"            Retrieves an image.\n"},"ImageCollection":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"},"example":null}}}},"description":"            Retrieves a list of images.\n"},"BulkPurchase":{"type":"object","properties":{"id":{"type":"integer","example":5839545},"company_id":{"type":"integer","example":602342},"name":{"type":"string","example":"Bulk Purchase"},"price":{"type":"integer","example":3200},"number_of_bookings":{"type":"integer","example":23},"description":{"type":"string","example":"Description of bulk purchase"},"duration":{"type":"integer","example":60},"days_valid_for":{"type":"integer","example":5},"use_from_date":{"type":"string","example":"2024-01-11"},"use_by_date":{"type":"string","example":"2024-01-16"},"days_to_use_by":{"type":"integer","example":5},"can_purchase":{"type":"boolean","example":true},"describe":{"type":"string","example":"Description"},"created_at":{"type":"string","example":"2023-12-30T12:44:23Z"},"updated_at":{"type":"string","example":"2023-12-30T12:44:23Z"}},"description":"              Retrieve a bulk purchase.\n"},"BulkPurchaseCollection":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"bulk_purchases":{"type":"array","items":{"$ref":"#/components/schemas/BulkPurchase"},"example":null}}}},"description":"              Retrieve a list of bulk purchases.\n"},"Booking":{"type":"object","properties":{"id":{"type":"string","example":"null"},"full_describe":{"type":"string","example":"null"},"describe":{"type":"string","example":"null"},"resource_name":{"type":"string","example":"null"},"person_name":{"type":"string","example":"null"},"datetime":{"type":"string","example":"null"},"end_datetime":{"type":"string","example":"null"},"duration":{"type":"string","example":"null"},"duration_span":{"type":"string","example":"null"},"listed_duration":{"type":"string","example":"null"},"on_waitlist":{"type":"string","example":"null"},"company_id":{"type":"string","example":"null"},"attended":{"type":"string","example":"null"},"price":{"type":"string","example":"null"},"original_price":{"type":"string","example":"null"},"due_now":{"type":"string","example":"null"},"paid":{"type":"string","example":"null"},"quantity":{"type":"string","example":"null"},"event_id":{"type":"string","example":"null"},"session_id":{"type":"string","example":"null"},"service_id":{"type":"string","example":"null"},"purchase_id":{"type":"string","example":"null"},"purchase_ref":{"type":"string","example":"null"},"settings":{"type":"string","example":"null"},"slot_settings":{"type":"string","example":"null"},"min_cancellation_time":{"type":"string","example":"null"},"service_name":{"type":"string","example":"null"},"category_name":{"type":"string","example":"null"},"time_zone":{"type":"string","example":"null"},"ticket_name":{"type":"string","example":"null"},"address":{"type":"string","example":"null"},"booking_type":{"type":"string","example":"null"},"slot_id":{"type":"string","example":"null"},"first_name":{"type":"string","example":"null"},"first_name_extra":{"type":"string","example":"null"},"last_name":{"type":"string","example":"null"},"last_name_extra":{"type":"string","example":"null"},"email":{"type":"string","example":"null"},"coupon_paid":{"type":"string","example":"null"},"coupon_title":{"type":"string","example":"null"},"coupon_code":{"type":"string","example":"null"},"tickets":{"type":"string","example":"null"},"recurrence_type":{"type":"string","example":"null"},"num_bookings":{"type":"string","example":"null"},"remaining":{"type":"string","example":"null"},"is_cancelled":{"type":"string","example":"null"},"private_note":{"type":"string","example":"null"},"channel":{"type":"string","example":"null"},"user_id":{"type":"string","example":"null"},"unpaid_cancel_time":{"type":"string","example":"null"},"_embedded":{"type":"object","properties":{"answers":{"type":"array","items":{"type":"string"},"example":null},"survey_answers":{"type":"array","items":{"type":"string"},"example":null}}},"person_id":{"type":"string","example":"null"},"person_ids":{"type":"string","example":"null"},"checked_in":{"type":"string","example":"null"},"check_in_code":{"type":"string","example":"null"},"price_in_major_units":{"type":"string","example":"null"},"original_price_in_major_units":{"type":"string","example":"null"},"paid_in_major_units":{"type":"string","example":"null"},"due_now_in_major_units":{"type":"string","example":"null"},"method_of_appointment":{"type":"string","example":"null"},"source":{"type":"string","example":"null"},"medium":{"type":"string","example":"null"},"campaign":{"type":"string","example":"null"},"assets":{"type":"string","example":"null"},"status":{"type":"string","example":"null"},"member_can_confirm_now":{"type":"string","example":"null"},"member_will_need_to_confirm_in_the_future":{"type":"string","example":"null"},"notification_preferences":{"type":"string","example":"null"}},"description":"Creates a single booking without requiring admin permissions. This is a basic API that\nonly allows creating a purchase with a single item. Use the basket APIs if booking\nmultiple items or if the there is a need to hold the time slot before the client\ncompletes the booking.\n"},"SessionLandingPage":{"type":"object","properties":{"id":{"type":"string","example":"null"},"session_id":{"type":"string","example":"null"},"created_at":{"type":"string","example":"null"},"updated_at":{"type":"string","example":"null"},"landing_page_config":{"type":"string","example":"null"}},"description":"Fetch Event Landing Page Configuration"},"Person":{"type":"object","properties":{"id":{"type":"integer","example":254543},"name":{"type":"string","example":"John Bull"},"description":{"type":"string","example":"A little bit about them"},"type":{"type":"string","example":"person"},"extra":{"type":"object","properties":{},"example":{"question_one":"Answer to question_one","question_two":"Answer to question two"}},"group_id":{"type":"integer","example":58459},"deleted":{"type":"boolean","example":false},"disabled":{"type":"boolean","example":false},"company_id":{"type":"integer","example":37000},"order":{"type":"integer","example":1},"group_name":{"type":"string","example":"Group"},"created_at":{"type":"string","example":"null"},"updated_at":{"type":"string","example":"null"},"_embedded":{"type":"object","properties":{"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"},"example":null}}}},"description":"Retrieves a bookable person.\n"},"PersonCollection":{"type":"object","properties":{"total_entries":{"type":"integer","example":100},"_embedded":{"type":"object","properties":{"people":{"type":"array","items":{"$ref":"#/components/schemas/Person"},"example":null}}}},"description":"Retrieves a list of bookable people.\nResults are returned in a paginated list.\n"},"Time":{"type":"object","properties":{"start":{"type":"string","example":"null"},"available":{"type":"string","example":"null"},"durations":{"type":"string","example":"null"},"prices":{"type":"string","example":"null"},"listed_durations":{"type":"string","example":"null"}},"description":"Read Time"},"TimeCollection":{"type":"object","properties":{"times":{"type":"array","items":{"type":"string"},"example":null}},"description":"          Get a list of available booking start times for a particular day.\n\n          The available durations and prices are included under each start time.\n\n          If person_id and resource_id are not specified and the service has multiple people or\n          resources (as specified by the who/what/where config), times that are the same but differ by\n          person or resource are merged together by default. If booking a particular person or\n          resource either pass in their IDs in the person_id and resource_id params or pass the\n          merge_times param as false.\n\n          Requested Assets (`requested_assets`), this parameters describe a list of rules which a time must\n          satisfy to be considered available.\n\n          A Requested asset consists of a\n          * company_rule -> can be either `default` (it will respect the company of the URL), `any` (it can be any company that provides the service), or `Array<CompanyID>` one of these companies (which must provide the service).\n          * person_rule -> can be either `any` (any person which provides the service), `any_or_none` (the user is indifferent as to whether a person is associated to the booking), `Array<PersonID>` one of these people who provide the service.\n          * resource_rule -> same as person_rule:  can be either `any` (any resource which provides the service), `any_or_none` (the user is indifferent as to whether a resource is associated to the booking), `Array<PersonID>` one of these resources with which the service can be provided.\n\n          Factors that influence availability include:\n\n          * Service, Person and Resource schedules\n          * Bookings and blocked time\n          * Company opening hours\n          * Max/min advance\n          * Min/max consecutive bookings (fixed time service)\n          * Durations (flex time service)\n          * Travel time (flex time service)\n          * Booking time step\n"},"DateCollection":{"type":"object","properties":{"dates":{"type":"array","items":{"type":"string"},"example":null}},"description":"          Get a list of available dates in which bookings can occur\n\n          The amount of times left available on each day are specified\n\n          If person_id and resource_id are not specified and the service has multiple people\n          or resources (as specified by the who/what/where config), it will count the times\n          for any given date\n"},"Guest":{"type":"object","properties":{"uuid":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"status":{"type":"string","example":"invited"},"number_of_extra_attendees":{"type":"integer","example":2},"total_attendees":{"type":"integer","example":3},"client_details":{"type":"object","properties":{},"example":null},"tickets":{"type":"object","properties":{},"example":null},"questions":{"type":"array","items":{"type":"string"},"example":null}},"description":"Retrieves guest details by UUID and Event ID including client details, questions,\nand timings. Both UUID and Event ID are required for security and accuracy.\n"},"CompanySettings":{"type":"object","properties":{"offer_login":{"type":"string","example":"null"},"has_coupons":{"type":"string","example":"null"},"use_shopping_basket":{"type":"string","example":"null"},"has_deals":{"type":"string","example":"null"},"has_vouchers":{"type":"string","example":"null"},"has_products":{"type":"string","example":"null"},"has_services":{"type":"string","example":"null"},"has_resources":{"type":"string","example":"null"},"has_people":{"type":"string","example":"null"},"has_groups":{"type":"string","example":"null"},"has_child_members":{"type":"string","example":"null"},"has_queues":{"type":"string","example":"null"},"has_images":{"type":"string","example":"null"},"has_repeating":{"type":"string","example":"null"},"has_subscription":{"type":"string","example":"null"},"has_packages":{"type":"string","example":"null"},"has_overbook":{"type":"string","example":"null"},"has_prepaid":{"type":"string","example":"null"},"has_reasons":{"type":"string","example":"null"},"has_addresses":{"type":"string","example":"null"},"has_events":{"type":"string","example":"null"},"has_classes":{"type":"string","example":"null"},"has_waitlists":{"type":"string","example":"null"},"no_recipients":{"type":"string","example":"null"},"has_prices":{"type":"string","example":"null"},"merge_resources":{"type":"string","example":"null"},"merge_people":{"type":"string","example":"null"},"payment_tax":{"type":"string","example":"null"},"currency":{"type":"string","example":"null"},"requires_login":{"type":"string","example":"null"},"has_wallets":{"type":"string","example":"null"},"ask_address":{"type":"string","example":"null"},"ask_mobile_phone":{"type":"string","example":"null"},"has_question_groups":{"type":"string","example":"null"},"use_private_services":{"type":"string","example":"null"},"enable_events_v3":{"type":"string","example":"null"},"desktop_notifications_enabled":{"type":"string","example":"null"},"sc_enabled":{"type":"string","example":"null"},"qms_real_time_dashboard_enabled":{"type":"string","example":"null"},"check_in_enabled":{"type":"string","example":"null"}}},"GlobalImage":{"type":"object","properties":{"id":{"type":"string","example":"null"},"company_id":{"type":"string","example":"null"},"name":{"type":"string","example":"null"},"image_file_name":{"type":"string","example":"null"},"foreign_key":{"type":"string","example":"null"},"url":{"type":"string","example":"null"}}}},"securitySchemes":{"App-Id":{"type":"apiKey","name":"App-Id","in":"header"}}},"x-original-swagger-version":"2.0","x-readme":{"explorer-enabled":true,"proxy-enabled":true}}