{"info":{"title":"API","description":"Our API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.","version":"1.15.2"},"components":{"securitySchemes":{"companyApiSecret":{"type":"http","scheme":"bearer"}},"schemas":{"CompaniesUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The company name."},"createdById":{"type":"string","description":"The user id created company."},"lang":{"type":"string","enum":["en","pt-BR","de","zh-Hans"],"description":"One of en, pt-BR, de, zh-Hans."},"plan":{"type":"string","enum":["TRIAL","FREE","BASIC","PREMIUM","ENTERPRISE"],"description":"The company current plan. It cannot be changed via API."},"planIsActive":{"type":"boolean","description":"Whether the company is active or not. It cannot be changed via API."},"trialUntil":{"type":"string","description":"Date until trial version can be used. It cannot be changed via API."},"location":{"type":"string","description":"Location company."},"pictureUrl":{"type":"string","description":"The company logo url."},"address":{"type":"string","description":"The company address."},"city":{"type":"string","description":"The company city."},"complement":{"type":"string","description":"The company complement."},"country":{"type":"string","description":"The company country."},"state":{"type":"string","description":"The province company."},"type":{"type":"string","description":""},"timezone":{"type":"string","description":"The company timezone Ex: America/Sao_Paulo"},"invitePrefix":{"type":"string","description":"This is used to integrate with Google and Microsoft calendars."},"phone":{"type":"string","description":"The company phone."},"email":{"type":"string","description":"The company email."},"countryCode":{"type":"string","description":"The company country code Ex: +1 Or +55."}}},"companies":{"title":"Company","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"name":{"type":"string"},"createdById":{"type":"string","nullable":true},"lang":{"type":"string","default":"en"},"plan":{"type":"string","enum":["TRIAL","FREE","BASIC","PREMIUM","ENTERPRISE"]},"planIsActive":{"type":"boolean","default":true},"trialUntil":{"type":"string","format":"date-time"},"location":{"type":"string","nullable":true},"pictureUrl":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"complement":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"type":{"type":"string","enum":["PARENT","CHILD","INDEPENDENT"],"default":"INDEPENDENT"},"timezone":{"type":"string","nullable":true},"invitePrefix":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"countryCode":{"type":"string","nullable":true},"touchlessId":{"type":"string","nullable":true},"parentCompanyId":{"type":"string","nullable":true},"mapAddressUrl":{"type":"string","nullable":true},"visibleOnKiosk":{"type":"boolean","default":true},"serproClientId":{"type":"string","nullable":true},"serproClientSecret":{"type":"string","nullable":true},"serproAuthToken":{"type":"string","nullable":true},"serproAuthTokenExpiresAt":{"type":"integer","format":"int64","nullable":true},"liberadoAuthToken":{"type":"string","nullable":true}},"required":["id","createdAt","updatedAt","deletedAt","name","lang","plan","planIsActive","trialUntil","type","visibleOnKiosk"]},"companies_list":{"title":"companies list","type":"array","items":{"$ref":"#/components/schemas/companies"}},"hostsAdd":{"type":"object","required":["email","name"],"properties":{"email":{"type":"string","description":"The email must be unique at each company"},"name":{"type":"string"},"sendInvitationEmail":{"type":"boolean","description":"If true, W3lcome will send an email inviting the host to create an account at w3lcome.com. Default: false"},"metadata":{"type":"object","description":"Optional object"},"role":{"type":"string","enum":["EMPLOYEE","ADMIN","FRONTDESK","MANAGER","HOST","SECURITY"],"description":"One of EMPLOYEE, ADMIN, FRONTDESK, MANAGER, HOST, SECURITY"},"additionalEmails":{"type":"string","description":"Emails separated by space"},"isActive":{"type":"boolean","description":"If true this host is active."},"pictureUrl":{"type":"string","description":"The avatar URL."},"position":{"type":"string"},"sector":{"type":"string"},"phone":{"type":"string"},"countryCode":{"type":"string"},"message":{"type":"string"},"resendInvitationEmail":{"type":"boolean","description":"When sent as \"true\", it will resend the welcome email to the host."},"allowCredentialing":{"type":"boolean","description":"When \"true\", it will allow the host to use credentialing flow."},"canAuthorizeAllCredentialing":{"type":"boolean","description":"When \"true\", it will allow the host to authorize credentialing requests of other hosts."}}},"hostUpdate":{"type":"object","properties":{"email":{"type":"string","description":"The email must be unique at each company"},"name":{"type":"string"},"sendInvitationEmail":{"type":"boolean","description":"If true, W3lcome will send an email inviting the host to create an account at w3lcome.com. Default: false"},"metadata":{"type":"object","description":"Optional object"},"role":{"type":"string","enum":["EMPLOYEE","ADMIN","FRONTDESK","MANAGER","HOST","SECURITY"],"description":"One of EMPLOYEE, ADMIN, FRONTDESK, MANAGER, HOST, SECURITY"},"additionalEmails":{"type":"string","description":"Emails separated by space"},"isActive":{"type":"boolean","description":"If true this host is active."},"pictureUrl":{"type":"string","description":"The avatar URL."},"position":{"type":"string"},"sector":{"type":"string"},"phone":{"type":"string"},"countryCode":{"type":"string"},"message":{"type":"string"},"resendInvitationEmail":{"type":"boolean","description":"When sent as \"true\", it will resend the welcome email to the host."},"allowCredentialing":{"type":"boolean","description":"When \"true\", it will allow the host to use credentialing flow."},"canAuthorizeAllCredentialing":{"type":"boolean","description":"When \"true\", it will allow the host to authorize credentialing requests of other hosts."}}},"hosts":{"title":"Host","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"name":{"type":"string"},"email":{"type":"string"},"role":{"type":"string","enum":["ADMIN","MANAGER","SECURITY","FRONTDESK","HOST","EMPLOYEE"],"default":"HOST"},"isActive":{"type":"boolean","default":true},"preCheckinNotifications":{"type":"boolean","default":true},"isPhoneValid":{"type":"boolean","default":false},"sendInvitationEmail":{"type":"boolean","default":false},"additionalEmails":{"type":"array","items":{"type":"string"},"nullable":true,"default":[]},"additionalPhones":{"type":"array","items":{"type":"string"},"nullable":true,"default":[]},"pictureUrl":{"type":"string","nullable":true},"pictureThumbUrl":{"type":"string","nullable":true},"position":{"type":"string","nullable":true},"cpf":{"type":"string","nullable":true},"sector":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"countryCode":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"deliveryNotification":{"type":"boolean","nullable":true,"default":false},"metadata":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"defaultMeetingLocationId":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true},"createdById":{"type":"string","nullable":true},"companyId":{"type":"string"},"defaultMeetingTypeId":{"type":"string","nullable":true},"zoneId":{"type":"string","nullable":true},"invenziId":{"type":"string","nullable":true},"mifareCardNumber":{"type":"array","items":{"type":"string"},"nullable":true},"allowCredentialing":{"type":"boolean","nullable":true,"default":false},"canAuthorizeAllCredentialing":{"type":"boolean","nullable":true,"default":false}},"required":["id","createdAt","updatedAt","deletedAt","name","email","role","isActive","preCheckinNotifications","isPhoneValid","sendInvitationEmail","additionalEmails","additionalPhones","deliveryNotification","companyId","allowCredentialing","canAuthorizeAllCredentialing"]},"hosts_list":{"title":"hosts list","type":"array","items":{"$ref":"#/components/schemas/hosts"}},"BlocklistAdd":{"type":"object","required":[],"properties":{"companyId":{"type":"string","description":"This is the company id"},"createdById":{"type":"string"},"name":{"type":"string"},"reason":{"type":"string","description":"Block reason"},"phone":{"type":"string"},"email":{"type":"string"},"document":{"type":"string"},"cpf":{"type":"string"},"rg":{"type":"string"}}},"BlocklistUpdate":{"type":"object","properties":{"companyId":{"type":"string","description":"This is the company id"},"createdById":{"type":"string"},"name":{"type":"string"},"reason":{"type":"string","description":"Block reason"},"phone":{"type":"string"},"email":{"type":"string"},"document":{"type":"string"},"cpf":{"type":"string"},"rg":{"type":"string"}}},"blocklists":{"title":"Blocklist","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"name":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"document":{"type":"string","nullable":true},"cpf":{"type":"string","nullable":true},"rg":{"type":"string","nullable":true},"createdById":{"type":"string","nullable":true},"companyId":{"type":"string"}},"required":["id","createdAt","updatedAt","deletedAt","companyId"]},"blocklists_list":{"title":"blocklists list","type":"array","items":{"$ref":"#/components/schemas/blocklists"}},"meetingsAdd":{"type":"object","required":["title","guests","start","end","location","type","hostId"],"properties":{"title":{"type":"string","description":"Meeting title."},"start":{"type":"string","description":"Meeting start date and time."},"end":{"type":"string","description":"Date and time of the end of the meeting."},"durationInHours":{"type":"number"},"isRecurring":{"type":"boolean","description":"If meeting is recurrence pass true."},"recurrencePattern":{"type":"string","description":""},"allDay":{"type":"boolean","description":"if true the meeting will be all day."},"timezone":{"type":"string","description":"The meeting timezone Ex: America/Sao_Paulo"},"message":{"type":"string"},"location":{"type":"string","description":"Location from where the meeting will take place."},"meetingLocationId":{"type":"string","description":"Id of the meeting location"},"notes":{"type":"string"},"type":{"type":"string","description":"Can be one the types: \"MEETING, EVENT\"."},"createdOn":{"type":"string","enum":["DASHBOARD","MOBILE","GOOGLE","MICROSOFT","API"],"description":"Location from where the meeting was created."},"guests":{"type":"array","items":{"type":"string"},"description":"Meeting invitees email list, an array of emails."},"companyId":{"type":"string","description":"id of the company that will host the meeting."},"hostId":{"type":"string","description":"The id of the host who is creating the meeting."},"inviteId":{"type":"string"}}},"meetingsUpdate":{"type":"object","properties":{"title":{"type":"string","description":"Meeting title."},"start":{"type":"string","description":"Meeting start date and time."},"end":{"type":"string","description":"Date and time of the end of the meeting."},"durationInHours":{"type":"number"},"isRecurring":{"type":"boolean","description":"If meeting is recurrence pass true."},"recurrencePattern":{"type":"string","description":""},"allDay":{"type":"boolean","description":"if true the meeting will be all day."},"timezone":{"type":"string","description":"The meeting timezone Ex: America/Sao_Paulo"},"message":{"type":"string"},"location":{"type":"string","description":"Location from where the meeting will take place."},"meetingLocationId":{"type":"string","description":"Id of the meeting location"},"notes":{"type":"string"},"type":{"type":"string","description":"Can be one the types: \"MEETING, EVENT\"."},"createdOn":{"type":"string","enum":["DASHBOARD","MOBILE","GOOGLE","MICROSOFT","API"],"description":"Location from where the meeting was created."},"guests":{"type":"array","items":{"type":"string"},"description":"Meeting invitees email list, an array of emails."},"companyId":{"type":"string","description":"id of the company that will host the meeting."},"hostId":{"type":"string","description":"The id of the host who is creating the meeting."},"inviteId":{"type":"string"}}},"meetings":{"title":"Meeting","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"title":{"type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"durationInHours":{"type":"integer","format":"int32","nullable":true},"isRecurring":{"type":"boolean","default":false},"recurrencePattern":{"type":"string","nullable":true},"allDay":{"type":"boolean","default":false},"timezone":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"location":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"createdOn":{"type":"string","enum":["DASHBOARD","MOBILE","GOOGLE","MICROSOFT","API"],"nullable":true,"default":"DASHBOARD"},"coHosts":{"type":"array","items":{"type":"string"},"nullable":true,"default":[]},"meetingTypeId":{"type":"string","nullable":true},"meetingLocationId":{"type":"string","nullable":true},"companyId":{"type":"string"},"hostId":{"type":"string"},"inviteId":{"type":"string","nullable":true},"lang":{"type":"string","default":"en"},"metadata":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"visitFlowTypeId":{"type":"string"},"guestType":{"type":"string","enum":["email","whatsapp"],"nullable":true,"default":"email"}},"required":["id","createdAt","updatedAt","deletedAt","title","start","end","isRecurring","allDay","createdOn","coHosts","companyId","hostId","lang","visitFlowTypeId","guestType"]},"meetings_list":{"title":"meetings list","type":"array","items":{"$ref":"#/components/schemas/meetings"}},"NotificationsAdd":{"type":"object","required":["type","message","hosts"],"properties":{"type":{"type":"string","description":"The notification type. It can be \"delivery\" or \"visit\"."},"companyId":{"type":"string","description":"The company id."},"message":{"type":"string","description":"Message sent to the hosts"},"hosts":{"type":"array","items":{"type":"object","required":["id"],"properties":{"type":{"type":"string","description":"It host"},"id":{"type":"string","description":"Host id"},"email":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"countryCode":{"type":"string"}}},"description":"An array of The Host Object"}}},"NotificationsUpdate":{"type":"object","properties":{"type":{"type":"string","description":"The notification type. It can be \"delivery\" or \"visit\"."},"companyId":{"type":"string","description":"The company id."},"message":{"type":"string","description":"Message sent to the hosts"},"hosts":{"type":"array","items":{"type":"object","required":["id"],"properties":{"type":{"type":"string","description":"It host"},"id":{"type":"string","description":"Host id"},"email":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"countryCode":{"type":"string"}}},"description":"An array of The Host Object"}}},"notifications":{"title":"Notification","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"type":{"type":"string"},"message":{"type":"string","nullable":true},"companyId":{"type":"string","nullable":true}},"required":["id","createdAt","updatedAt","deletedAt","type"]},"notifications_list":{"title":"notifications list","type":"array","items":{"$ref":"#/components/schemas/notifications"}},"visitsAdd":{"type":"object","required":["visit","visitor"],"properties":{"visit":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"UUIDv4."},"hostId":{"type":"string","description":"The host you will be visiting on."},"checkinType":{"type":"string","enum":["IPAD","DASHBOARD","API","MOBILE"],"description":"One of IPAD, DASHBOARD, API, MOBILE."},"checkoutType":{"type":"string","enum":["IPAD","DASHBOARD","API","MOBILE"],"description":"One of IPAD, DASHBOARD, API, MOBILE."},"cardNumber":{"type":"string","description":"The visitor card number used to integrate with ticket gates."},"expectedAt":{"type":"string","description":"The expected date when the visitor has an invite."},"checkinAt":{"type":"string","description":"Check-in date."},"finishCheckinAt":{"type":"string","description":"The date the visitor finished the check-in."},"checkoutAt":{"type":"string","description":"Check-out date."},"authorizedById":{"type":"string","description":"The id of the host who authorized the visit."},"authorizedAt":{"type":"string","description":"The date that the visit was allowed or denied."},"authorizationVia":{"type":"string","enum":["DASHBOARD","INVITE","LINK","APP","W-ACCESS"],"description":"Location to which the visit was approved. One of DASHBOARD, INVITE, LINK, APP."},"authorizationLink":{"type":"string","description":"Link sent to the host to allow or deny the visit."},"authorizationStatus":{"type":"string","enum":["AWAITING","ALLOWED","DENIED"],"description":"What is the authorization status of the visit. One of AWAITING, ALLOWED, DENIED."},"checkinByHostId":{"type":"string","description":"Id of the host that the visitor has checked-in."},"checkinByIpadId":{"type":"string","description":"Id of the iPad that the visitor has checked-in."},"checkoutByHostId":{"type":"string","description":"Id of the host that the visitor has checked-out."},"checkoutByIpadId":{"type":"string","description":"Id of the iPad that the visitor has checked-out."},"notes":{"type":"string","description":"Notes about this visit."},"customHostName":{"type":"string","description":"Custom host name when the company allows it."},"meetingId":{"type":"string","description":"The id of the meeting this visit was invited to."},"companyId":{"type":"string","description":"The id of the company."},"visitorId":{"type":"string","description":"The id of the visitor."},"userId":{"type":"string","description":"The id of the user linked to this visit."},"isCanceled":{"type":"boolean","description":"It indicates if the visit is canceled after pre-check-in and before check-in"},"feedbacks":{"type":"array","items":{"type":"object","required":["customFieldId","value"],"properties":{"customFieldId":{"type":"string","description":"Id of the custom field."},"isCorrect":{"type":"boolean","description":"Only used for questionnaire fields to indicate if it was correct or not"},"name":{"type":"string","description":"The question."},"localizedName":{"type":"object","properties":{"en":{"type":"string","description":"This is the English question translation."},"pt-BR":{"type":"string","description":"This is the Portuguese question translation."},"zh-Hans":{"type":"string","description":"This is the Chinese question translation."}},"description":"The translation of the question."},"localizedValue":{"type":"object","properties":{"en":{"type":"string","description":"This is the English answer translation."},"pt-BR":{"type":"string","description":"This is the Portuguese answer translation."},"zh-Hans":{"type":"string","description":"This is the Chinese answer translation."}},"description":"The translation of the question answer."},"sort":{"type":"number","description":"This serves to order the custom fields starting from 0, where 0 is for the first field shown."},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT","QUESTIONNAIRE","HOST_EXTRA_INFO"],"description":"The type of the custom field"},"value":{"type":"string","description":"The question answer."},"visitorId":{"type":"string","description":"Id of the visitor who answered the question."},"visitId":{"type":"string","description":"Id of the visit who answered the question."},"meetingId":{"type":"string","description":"If the question is in meeting, add the meeting id."}}},"description":"List of values of feedbacks."},"customFields":{"type":"array","items":{"type":"object","required":["customFieldId","value"],"properties":{"customFieldId":{"type":"string","description":"Id of the custom field."},"isCorrect":{"type":"boolean","description":"Only used for questionnaire fields to indicate if it was correct or not"},"name":{"type":"string","description":"The question."},"localizedName":{"type":"object","properties":{"en":{"type":"string","description":"This is the English question translation."},"pt-BR":{"type":"string","description":"This is the Portuguese question translation."},"zh-Hans":{"type":"string","description":"This is the Chinese question translation."}},"description":"The translation of the question."},"localizedValue":{"type":"object","properties":{"en":{"type":"string","description":"This is the English answer translation."},"pt-BR":{"type":"string","description":"This is the Portuguese answer translation."},"zh-Hans":{"type":"string","description":"This is the Chinese answer translation."}},"description":"The translation of the question answer."},"sort":{"type":"number","description":"This serves to order the custom fields starting from 0, where 0 is for the first field shown."},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT","QUESTIONNAIRE","HOST_EXTRA_INFO"],"description":"The type of the custom field"},"value":{"type":"string","description":"The question answer."},"visitorId":{"type":"string","description":"Id of the visitor who answered the question."},"visitId":{"type":"string","description":"Id of the visit who answered the question."},"meetingId":{"type":"string","description":"If the question is in meeting, add the meeting id."}}},"description":"List of values of custom fields"},"questionnaireFields":{"type":"array","items":{"type":"object","required":["customFieldId","value"],"properties":{"customFieldId":{"type":"string","description":"Id of the custom field."},"isCorrect":{"type":"boolean","description":"Only used for questionnaire fields to indicate if it was correct or not"},"name":{"type":"string","description":"The question."},"localizedName":{"type":"object","properties":{"en":{"type":"string","description":"This is the English question translation."},"pt-BR":{"type":"string","description":"This is the Portuguese question translation."},"zh-Hans":{"type":"string","description":"This is the Chinese question translation."}},"description":"The translation of the question."},"localizedValue":{"type":"object","properties":{"en":{"type":"string","description":"This is the English answer translation."},"pt-BR":{"type":"string","description":"This is the Portuguese answer translation."},"zh-Hans":{"type":"string","description":"This is the Chinese answer translation."}},"description":"The translation of the question answer."},"sort":{"type":"number","description":"This serves to order the custom fields starting from 0, where 0 is for the first field shown."},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT","QUESTIONNAIRE","HOST_EXTRA_INFO"],"description":"The type of the custom field"},"value":{"type":"string","description":"The question answer."},"visitorId":{"type":"string","description":"Id of the visitor who answered the question."},"visitId":{"type":"string","description":"Id of the visit who answered the question."},"meetingId":{"type":"string","description":"If the question is in meeting, add the meeting id."}}},"description":"List of values of questionnaire fields"},"firstAccessAt":{"type":"string","description":"First Access date."},"timeToDelayVisit":{"type":"Date","description":"Date will the visit be postponed"}}},"visitNda":{"type":"string","description":"An pdf with signature in Base64."},"visitPicture":{"type":"string","description":"An image in Base64."}}},"visitsUpdate":{"type":"object","properties":{"visit":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"UUIDv4."},"hostId":{"type":"string","description":"The host you will be visiting on."},"checkinType":{"type":"string","enum":["IPAD","DASHBOARD","API","MOBILE"],"description":"One of IPAD, DASHBOARD, API, MOBILE."},"checkoutType":{"type":"string","enum":["IPAD","DASHBOARD","API","MOBILE"],"description":"One of IPAD, DASHBOARD, API, MOBILE."},"cardNumber":{"type":"string","description":"The visitor card number used to integrate with ticket gates."},"expectedAt":{"type":"string","description":"The expected date when the visitor has an invite."},"checkinAt":{"type":"string","description":"Check-in date."},"finishCheckinAt":{"type":"string","description":"The date the visitor finished the check-in."},"checkoutAt":{"type":"string","description":"Check-out date."},"authorizedById":{"type":"string","description":"The id of the host who authorized the visit."},"authorizedAt":{"type":"string","description":"The date that the visit was allowed or denied."},"authorizationVia":{"type":"string","enum":["DASHBOARD","INVITE","LINK","APP","W-ACCESS"],"description":"Location to which the visit was approved. One of DASHBOARD, INVITE, LINK, APP."},"authorizationLink":{"type":"string","description":"Link sent to the host to allow or deny the visit."},"authorizationStatus":{"type":"string","enum":["AWAITING","ALLOWED","DENIED"],"description":"What is the authorization status of the visit. One of AWAITING, ALLOWED, DENIED."},"checkinByHostId":{"type":"string","description":"Id of the host that the visitor has checked-in."},"checkinByIpadId":{"type":"string","description":"Id of the iPad that the visitor has checked-in."},"checkoutByHostId":{"type":"string","description":"Id of the host that the visitor has checked-out."},"checkoutByIpadId":{"type":"string","description":"Id of the iPad that the visitor has checked-out."},"notes":{"type":"string","description":"Notes about this visit."},"customHostName":{"type":"string","description":"Custom host name when the company allows it."},"meetingId":{"type":"string","description":"The id of the meeting this visit was invited to."},"companyId":{"type":"string","description":"The id of the company."},"visitorId":{"type":"string","description":"The id of the visitor."},"userId":{"type":"string","description":"The id of the user linked to this visit."},"isCanceled":{"type":"boolean","description":"It indicates if the visit is canceled after pre-check-in and before check-in"},"feedbacks":{"type":"array","items":{"type":"object","required":["customFieldId","value"],"properties":{"customFieldId":{"type":"string","description":"Id of the custom field."},"isCorrect":{"type":"boolean","description":"Only used for questionnaire fields to indicate if it was correct or not"},"name":{"type":"string","description":"The question."},"localizedName":{"type":"object","properties":{"en":{"type":"string","description":"This is the English question translation."},"pt-BR":{"type":"string","description":"This is the Portuguese question translation."},"zh-Hans":{"type":"string","description":"This is the Chinese question translation."}},"description":"The translation of the question."},"localizedValue":{"type":"object","properties":{"en":{"type":"string","description":"This is the English answer translation."},"pt-BR":{"type":"string","description":"This is the Portuguese answer translation."},"zh-Hans":{"type":"string","description":"This is the Chinese answer translation."}},"description":"The translation of the question answer."},"sort":{"type":"number","description":"This serves to order the custom fields starting from 0, where 0 is for the first field shown."},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT","QUESTIONNAIRE","HOST_EXTRA_INFO"],"description":"The type of the custom field"},"value":{"type":"string","description":"The question answer."},"visitorId":{"type":"string","description":"Id of the visitor who answered the question."},"visitId":{"type":"string","description":"Id of the visit who answered the question."},"meetingId":{"type":"string","description":"If the question is in meeting, add the meeting id."}}},"description":"List of values of feedbacks."},"customFields":{"type":"array","items":{"type":"object","required":["customFieldId","value"],"properties":{"customFieldId":{"type":"string","description":"Id of the custom field."},"isCorrect":{"type":"boolean","description":"Only used for questionnaire fields to indicate if it was correct or not"},"name":{"type":"string","description":"The question."},"localizedName":{"type":"object","properties":{"en":{"type":"string","description":"This is the English question translation."},"pt-BR":{"type":"string","description":"This is the Portuguese question translation."},"zh-Hans":{"type":"string","description":"This is the Chinese question translation."}},"description":"The translation of the question."},"localizedValue":{"type":"object","properties":{"en":{"type":"string","description":"This is the English answer translation."},"pt-BR":{"type":"string","description":"This is the Portuguese answer translation."},"zh-Hans":{"type":"string","description":"This is the Chinese answer translation."}},"description":"The translation of the question answer."},"sort":{"type":"number","description":"This serves to order the custom fields starting from 0, where 0 is for the first field shown."},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT","QUESTIONNAIRE","HOST_EXTRA_INFO"],"description":"The type of the custom field"},"value":{"type":"string","description":"The question answer."},"visitorId":{"type":"string","description":"Id of the visitor who answered the question."},"visitId":{"type":"string","description":"Id of the visit who answered the question."},"meetingId":{"type":"string","description":"If the question is in meeting, add the meeting id."}}},"description":"List of values of custom fields"},"questionnaireFields":{"type":"array","items":{"type":"object","required":["customFieldId","value"],"properties":{"customFieldId":{"type":"string","description":"Id of the custom field."},"isCorrect":{"type":"boolean","description":"Only used for questionnaire fields to indicate if it was correct or not"},"name":{"type":"string","description":"The question."},"localizedName":{"type":"object","properties":{"en":{"type":"string","description":"This is the English question translation."},"pt-BR":{"type":"string","description":"This is the Portuguese question translation."},"zh-Hans":{"type":"string","description":"This is the Chinese question translation."}},"description":"The translation of the question."},"localizedValue":{"type":"object","properties":{"en":{"type":"string","description":"This is the English answer translation."},"pt-BR":{"type":"string","description":"This is the Portuguese answer translation."},"zh-Hans":{"type":"string","description":"This is the Chinese answer translation."}},"description":"The translation of the question answer."},"sort":{"type":"number","description":"This serves to order the custom fields starting from 0, where 0 is for the first field shown."},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT","QUESTIONNAIRE","HOST_EXTRA_INFO"],"description":"The type of the custom field"},"value":{"type":"string","description":"The question answer."},"visitorId":{"type":"string","description":"Id of the visitor who answered the question."},"visitId":{"type":"string","description":"Id of the visit who answered the question."},"meetingId":{"type":"string","description":"If the question is in meeting, add the meeting id."}}},"description":"List of values of questionnaire fields"},"firstAccessAt":{"type":"string","description":"First Access date."},"timeToDelayVisit":{"type":"Date","description":"Date will the visit be postponed"}}},"visitNda":{"type":"string","description":"An pdf with signature in Base64."},"visitPicture":{"type":"string","description":"An image in Base64."}}},"visits":{"title":"Visit","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"cardNumber":{"type":"string","nullable":true},"issuanceToken":{"type":"string","nullable":true},"expectedAt":{"type":"string","format":"date-time","nullable":true},"expectedOutAt":{"type":"string","format":"date-time","nullable":true},"checkinAt":{"type":"string","format":"date-time","nullable":true},"checkinType":{"type":"string","enum":["IPAD","DASHBOARD","API","MOBILE","INVITES","AUTOMATIC"],"nullable":true},"checkoutType":{"type":"string","enum":["IPAD","DASHBOARD","API","MOBILE","INVITES","AUTOMATIC"],"nullable":true},"finishCheckinAt":{"type":"string","format":"date-time","nullable":true},"checkoutAt":{"type":"string","format":"date-time","nullable":true},"authorizedById":{"type":"string","nullable":true},"authorizedAt":{"type":"string","format":"date-time","nullable":true},"authorizationVia":{"type":"string","enum":["DASHBOARD","INVITE","LINK","APP","W-ACCESS"],"nullable":true},"authorizationLink":{"type":"string","nullable":true},"authorizationStatus":{"type":"string","enum":["AWAITING","ALLOWED","DENIED"],"nullable":true},"checkinByHostId":{"type":"string","nullable":true},"checkinByIpadId":{"type":"string","nullable":true},"checkoutByHostId":{"type":"string","nullable":true},"checkoutByIpadId":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"customHostName":{"type":"string","nullable":true},"hostId":{"type":"string","nullable":true},"meetingId":{"type":"string","nullable":true},"companyId":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true},"lang":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"cpf":{"type":"string","nullable":true},"rg":{"type":"string","nullable":true},"document":{"type":"string","nullable":true},"companyname":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"position":{"type":"string","nullable":true},"plate":{"type":"string","nullable":true},"sector":{"type":"string","nullable":true},"pictureUrl":{"type":"string","nullable":true},"pictureMediumUrl":{"type":"string","nullable":true},"pictureThumbUrl":{"type":"string","nullable":true},"ndaUrl":{"type":"string","nullable":true},"metadata":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"retakePicture":{"type":"boolean","default":false},"ndaSignedAt":{"type":"string","format":"date-time","nullable":true},"questionnaireAnsweredAt":{"type":"string","format":"date-time","nullable":true},"isCanceled":{"type":"boolean","default":false},"identity_card":{"type":"string","nullable":true},"isForeigner":{"type":"boolean","nullable":true},"chosen_name":{"type":"string","nullable":true},"gdprAgreedAt":{"type":"string","format":"date-time","nullable":true},"isAnonymous":{"type":"boolean","default":false},"invenziId":{"type":"string","nullable":true},"mifareCardNumber":{"type":"string","nullable":true},"smsOtpValidationId":{"type":"string","nullable":true},"firstAccessAt":{"type":"string","format":"date-time","nullable":true},"accessLevelId":{"type":"string","nullable":true},"timeToDelayVisit":{"type":"string","format":"date-time","nullable":true},"visitorNoteDenied":{"type":"string","nullable":true},"credentialedVisit":{"type":"boolean","nullable":true},"visitFlowTypeId":{"type":"string"},"identityValidated":{"type":"boolean","nullable":true}},"required":["id","createdAt","updatedAt","deletedAt","retakePicture","isCanceled","isAnonymous","visitFlowTypeId"]},"visits_list":{"title":"visits list","type":"array","items":{"$ref":"#/components/schemas/visits"}},"DeliveriesAdd":{"type":"object","required":[],"properties":{"pickupStatus":{"type":"string","enum":["AWAITING","PICKEDUP","PROBLEM","NONE"],"description":"One of AWAITING, PICKEDUP, PROBLEM, NONE."},"reportMessage":{"type":"string"},"notes":{"type":"string","description":"Some note about delivery."},"deliveryPicture":{"type":"string","description":"An image in Base64."},"companyId":{"type":"string","description":"The company id."},"message":{"type":"string","description":"Message sent to the hosts"},"hosts":{"type":"array","items":{"type":"object","required":["id"],"properties":{"type":{"type":"string","description":"It host"},"id":{"type":"string","description":"Host id"},"email":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"countryCode":{"type":"string"}}},"description":"An array of The Host Object"}}},"DeliveriesUpdate":{"type":"object","properties":{"pickupStatus":{"type":"string","enum":["AWAITING","PICKEDUP","PROBLEM","NONE"],"description":"One of AWAITING, PICKEDUP, PROBLEM, NONE."},"reportMessage":{"type":"string"},"notes":{"type":"string","description":"Some note about delivery."},"deliveryPicture":{"type":"string","description":"An image in Base64."},"companyId":{"type":"string","description":"The company id."},"message":{"type":"string","description":"Message sent to the hosts"},"hosts":{"type":"array","items":{"type":"object","required":["id"],"properties":{"type":{"type":"string","description":"It host"},"id":{"type":"string","description":"Host id"},"email":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"countryCode":{"type":"string"}}},"description":"An array of The Host Object"}}},"deliveries":{"title":"Delivery","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"pictureUrl":{"type":"string","nullable":true},"createdByHostId":{"type":"string","nullable":true},"createdByIpadId":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"pickupStatus":{"type":"string","enum":["AWAITING","PICKEDUP","PROBLEM","NONE"],"nullable":true},"pickupUpdatedAt":{"type":"string","format":"date-time","nullable":true},"pickupById":{"type":"string","nullable":true},"reportMessage":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"companyId":{"type":"string","nullable":true}},"required":["id","createdAt","updatedAt","deletedAt"]},"deliveries_list":{"title":"deliveries list","type":"array","items":{"$ref":"#/components/schemas/deliveries"}},"webhooksAdd":{"type":"object","required":["url","events"],"properties":{"url":{"type":"string","description":"The URL where the information will be sent."},"secret":{"type":"string","description":"A secret key to generate a hash and send the key every request via the X-Hub-Signature header."},"events":{"type":"string","description":"you can choose all with *, one or more with host_added, host_updated, host_deleted, visit_added, visit_updated, visit_deleted, delivery_added, delivery_updated, delivery_deleted, notification_added, notification_updated, notification_deleted"},"companyId":{"type":"string","description":"This is the company id"}}},"webhooksUpdate":{"type":"object","properties":{"url":{"type":"string","description":"The URL where the information will be sent."},"secret":{"type":"string","description":"A secret key to generate a hash and send the key every request via the X-Hub-Signature header."},"events":{"type":"string","description":"you can choose all with *, one or more with host_added, host_updated, host_deleted, visit_added, visit_updated, visit_deleted, delivery_added, delivery_updated, delivery_deleted, notification_added, notification_updated, notification_deleted"},"companyId":{"type":"string","description":"This is the company id"}}},"webhooks":{"title":"Webhook","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"url":{"type":"string"},"secret":{"type":"string"},"events":{"type":"string"},"companyId":{"type":"string"},"createdById":{"type":"string","nullable":true}},"required":["id","createdAt","updatedAt","deletedAt","url","secret","events","companyId"]},"webhooks_list":{"title":"webhooks list","type":"array","items":{"$ref":"#/components/schemas/webhooks"}},"QRCodelistFind":{"type":"array","required":[],"items":{"properties":{"readByHostId":{"type":"string","description":"Host id that read the qrcode."},"visitId":{"type":"string","description":"Visit id that the qrcode was read (if it is a visit)."},"hostId":{"type":"Host id that the qrcode was read (if it is a host)."},"metadata":{"type":"object","description":"Optional object"},"isZoneAuthorized":{"type":"boolean","description":"Checking if the host is authorized in the zone"},"zoneId":{"type":"string","description":"Zone ID where the qrcode was read"}}}},"QRCodelistGet":{"type":"object","required":[],"properties":{"readByHostId":{"type":"string","description":"Host id that read the qrcode."},"visitId":{"type":"string","description":"Visit id that the qrcode was read (if it is a visit)."},"hostId":{"type":"Host id that the qrcode was read (if it is a host)."},"metadata":{"type":"object","description":"Optional object"},"isZoneAuthorized":{"type":"boolean","description":"Checking if the host is authorized in the zone"},"zoneId":{"type":"string","description":"Zone ID where the qrcode was read"}}},"qrcodes":{"title":"Qrcode","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"companyId":{"type":"string","nullable":true},"readByHostId":{"type":"string","nullable":true},"visitId":{"type":"string","nullable":true},"hostId":{"type":"string","nullable":true},"metadata":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"isZoneAuthorized":{"type":"boolean","nullable":true},"zoneId":{"type":"string","nullable":true}},"required":["id","createdAt","updatedAt","deletedAt"]},"qrcodes_list":{"title":"qrcodes list","type":"array","items":{"$ref":"#/components/schemas/qrcodes"}},"companyIntegrationsAdd":{"type":"object","required":["type","content"],"properties":{"type":{"type":"string","enum":["dimep","acesse"],"description":"One of dimep or acesse"},"content":{"type":"object","properties":{"url":{"type":"string","description":"Url to access endpoint."},"username":{"type":"string","description":"Username to acess integration."},"password":{"type":"string","description":"Password to validade integration."},"culture":{"type":"string","description":"Example pt-BR, en..."},"nak":{"type":"string","description":""}},"description":"it is the object used to make the connection with the integration dimep."},"companyId":{"type":"string","description":"The id of company."}}},"companyIntegrationsUpdate":{"type":"object","properties":{"type":{"type":"string","enum":["dimep","acesse"],"description":"One of dimep or acesse"},"content":{"type":"object","properties":{"url":{"type":"string","description":"Url to access endpoint."},"username":{"type":"string","description":"Username to acess integration."},"password":{"type":"string","description":"Password to validade integration."},"culture":{"type":"string","description":"Example pt-BR, en..."},"nak":{"type":"string","description":""}},"description":"it is the object used to make the connection with the integration dimep."},"companyId":{"type":"string","description":"The id of company."}}},"company-integrations":{"title":"Company_integration","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"type":{"type":"string"},"content":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"companyId":{"type":"string"}},"required":["id","createdAt","updatedAt","deletedAt","type","content","companyId"]},"company-integrations_list":{"title":"company-integrations list","type":"array","items":{"$ref":"#/components/schemas/company-integrations"}},"customizationUpdate":{"type":"object","properties":{"backgroundColor":{"type":"string","description":"Customized color for company background"},"mainColor":{"type":"string","description":"Customized color for company main color"},"textColor":{"type":"string","description":"Customized color for company text"},"displayName":{"type":"string","description":"Name of the company that you want to display"},"feedbackEnabled":{"type":"boolean","description":""},"ipadMessage":{"type":"string","description":""},"ipadMessageSize":{"type":"number","description":""},"ipadMessageAlign":{"type":"string","enum":["LEFT","CENTER","RIGHT"],"description":"One of LEFT, CENTER, RIGHT."},"ipadSlideshowImages":{"type":"array","items":{},"description":"An array of image URLs on which will be shown on the iPad’s home screen."},"ipadSlideshowDuration":{"type":"number","description":"The time in seconds on which each image will be shown on the iPad’s home screen."},"ipadLogoHeight":{"type":"number","description":""},"ipadLogoTopHeight":{"type":"number","description":""},"ipadCheckInButtonTitle":{"type":"string","description":""},"ipadCheckOutButtonTitle":{"type":"string","description":""},"ipadSeeYouDuration":{"type":"number","description":""},"ipadSeeYouMessage":{"type":"string","description":""},"ipadWelcomeDuration":{"type":"number","description":""},"ipadWelcomeMessage":{"type":"string","description":""},"signOutEnabled":{"type":"boolean","description":""},"ipadSignOutQRCodeDefault":{"type":"boolean","description":""},"hostEnabled":{"type":"boolean","description":""},"hostDisplayAll":{"type":"boolean","description":""},"hostVisitorCanAdd":{"type":"boolean","description":""},"hostDisplayLabel":{"type":"string","description":""},"hostSubtitleType":{"type":"string","enum":["POSITION","SECTOR","EMAIL","PHONE"],"description":"One of POSITION, SECTOR, EMAIL, PHONE."},"nameRequired":{"type":"boolean","description":"If true, name will be require to fulfill sign-in Flow"},"namePlaceholder":{"type":"string","description":""},"primaryKey":{"type":"string","description":"Can be one the types: \"EMAIL, PHONE, CPF, RG, DOCUMENT\"."},"ndaEnabled":{"type":"boolean","description":""},"ndaLastEdited":{"type":"string","description":""},"ndaText":{"type":"string","description":""},"ndaImage":{"type":"string","description":""},"ndaValidForDays":{"type":"number","description":"Number of days which the NDA will be valid for."},"pictureEnabled":{"type":"boolean","description":"if false, it is not necessary to take picture."},"pictureUnique":{"type":"boolean","description":"If true, the visitor’s picture will be taken only once and reused on each visit."},"pictureCanSkip":{"type":"boolean","description":"If true, users can skip picture while doing a check-in."},"authorizationEnabled":{"type":"boolean","description":"If true, visits will need to be authorized before checking-in"},"authorizationWithNotes":{"type":"boolean","description":""},"gdprEnabled":{"type":"boolean","description":""},"gdprText":{"type":"string","description":""},"gdprAnonymouslyCheckin":{"type":"boolean","description":""},"deliveriesEnabled":{"type":"boolean","description":""},"deliveriesResponsibleHosts":{"type":"boolean","description":""},"ipadDeliveriesMessage":{"type":"string","description":""},"ipadDeliveriesDuration":{"type":"number","description":""},"ipadDeliveriesDisplayAll":{"type":"boolean","description":""},"ipadDeliveriesIsPictureEnabled":{"type":"boolean","description":""},"ipadDeliveriesMultipleSelection":{"type":"boolean","description":""},"blocklistEnabled":{"type":"boolean","description":"If true, the company can add visits to a blocklist."},"uniqueVisitEnabled":{"type":"boolean","description":""},"qrCodeCheckinEnabled":{"type":"boolean","description":"Show the QR Code button on the totem"},"disableScreenTimer":{"type":"boolean","description":""},"isZoneAuthorizationEnabled":{"type":"boolean","description":""},"dashboardCheckin":{"type":"boolean","description":""},"dashboardNotification":{"type":"boolean","description":""},"inviteWithAccount":{"type":"boolean","description":"if true, visits can not precheckin without login into a account first."},"waccessIntegration":{"type":"boolean","description":""},"waccessIntegrationOnlyQRCode":{"type":"boolean","description":""},"emailNotification":{"type":"boolean","description":"If true, sends an email notification when specific events occur"},"smsNotification":{"type":"boolean","description":"If true, sends a sms notification when specific events occur"},"whatsappNotification":{"type":"boolean","description":"If true, sends a whatsapp message when specific events occur"},"whatsappPlan":{"type":"string","enum":["TOTEM_VISITOR_WHATSAPP_HOST_WHATSAPP","TOTEM_VISITOR_WHATSAPP_HOST_APP","INVITE_VISITOR_WHATSAPP_HOST_APP","INVITE_VISITOR_WHATSAPP_HOST_WHATSAPP"],"description":"WhatsappPlan plan: Visitor always via WhatsApp; Host available on WhatsApp only when(TOTEM_VISITOR_WHATSAPP_HOST_WHATSAPP, INVITE_VISITOR_WHATSAPP_HOST_WHATSAPP) or via App (TOTEM_VISITOR_WHATSAPP_HOST_APP, INVITE_VISITOR_WHATSAPP_HOST_APP)"},"automaticCheckOutEnabled":{"type":"boolean","description":""},"automaticCheckOutHour":{"type":"number","description":""},"isVisitsDeletionEnabled":{"type":"boolean","description":"if true, visits are deleted after a number of days"},"deleteVisitsAfterDays":{"type":"number","description":""},"companyId":{"type":"string","description":"Company ID from which customization variables are used"},"feedbacks":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for the custom field."},"name":{"type":"string","description":"The question asked to the visitor."},"required":{"type":"boolean","description":"If true, this field is mandatory for the visitor. Default: false."},"sort":{"type":"number","description":"This serves to order the custom fields starting from 0, where 0 is for the first field shown."},"placeholder":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It is the placeholder translations shown to the visit."},"type":{"type":"string","enum":["EMAIL","PHONE","ADDRESS","COMPANYNAME","SECTOR","POSITION","DOCUMENT","RG","CPF","NAME","PLATE","TEXT","DROPDOWN","SCALE"],"description":"It’s an ENUM field that can receive those values: EMAIL, PHONE, ADDRESS,COMPANYNAME, SECTOR, POSITION, DOCUMENT, RG, CPF, NAME, PLATETEXT, DROPDOWN, SCALE"},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT"],"description":"It’s an ENUM field that can receive those values: FIELD, FEEDBACK, MEETING_HOST, or MEETING_VISIT"},"customType":{"type":"boolean","description":"This value will be false when the field type is one of these types: EMAIL, PHONE, ADDRESS, COMPANYNAME, SECTOR, POSITION, DOCUMENT, RG, CPF, NAME, PLATE, and will be true when the field type is one of these: TEXT, DROPDOWN, SCALE."},"disabled":{"type":"boolean","description":"This value is false by default. However, this property can be used to change the field to read-only."},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for each option."},"name":{"type":"string","description":"The option response asked to the visitor."},"localizedName":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It is the asked option translations shown to the visit."}}},"description":"Values for the DROPDOWN options when the field type is DROPDOWN."},"customizationId":{"type":"string","description":"This is the company customization id."},"alwaysRequireInput":{"type":"boolean","description":"This value is false by default. However, this property can be used to make the field input be always requested for recurrent visitors."}}},"description":""},"fields":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for the custom field."},"name":{"type":"string","description":"The question asked to the visitor."},"required":{"type":"boolean","description":"If true, this field is mandatory for the visitor. Default: false."},"sort":{"type":"number","description":"This serves to order the custom fields starting from 0, where 0 is for the first field shown."},"placeholder":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It is the placeholder translations shown to the visit."},"type":{"type":"string","enum":["EMAIL","PHONE","ADDRESS","COMPANYNAME","SECTOR","POSITION","DOCUMENT","RG","CPF","NAME","PLATE","TEXT","DROPDOWN","SCALE"],"description":"It’s an ENUM field that can receive those values: EMAIL, PHONE, ADDRESS,COMPANYNAME, SECTOR, POSITION, DOCUMENT, RG, CPF, NAME, PLATETEXT, DROPDOWN, SCALE"},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT"],"description":"It’s an ENUM field that can receive those values: FIELD, FEEDBACK, MEETING_HOST, or MEETING_VISIT"},"customType":{"type":"boolean","description":"This value will be false when the field type is one of these types: EMAIL, PHONE, ADDRESS, COMPANYNAME, SECTOR, POSITION, DOCUMENT, RG, CPF, NAME, PLATE, and will be true when the field type is one of these: TEXT, DROPDOWN, SCALE."},"disabled":{"type":"boolean","description":"This value is false by default. However, this property can be used to change the field to read-only."},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for each option."},"name":{"type":"string","description":"The option response asked to the visitor."},"localizedName":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It is the asked option translations shown to the visit."}}},"description":"Values for the DROPDOWN options when the field type is DROPDOWN."},"customizationId":{"type":"string","description":"This is the company customization id."},"alwaysRequireInput":{"type":"boolean","description":"This value is false by default. However, this property can be used to make the field input be always requested for recurrent visitors."}}},"description":""},"questionnaireFields":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for the custom field."},"name":{"type":"string","description":"The question asked to the visitor."},"required":{"type":"boolean","description":"If true, this field is mandatory for the visitor. Default: false."},"sort":{"type":"number","description":"This serves to order the custom fields starting from 0, where 0 is for the first field shown."},"placeholder":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It is the placeholder translations shown to the visit."},"type":{"type":"string","enum":["EMAIL","PHONE","ADDRESS","COMPANYNAME","SECTOR","POSITION","DOCUMENT","RG","CPF","NAME","PLATE","TEXT","DROPDOWN","SCALE"],"description":"It’s an ENUM field that can receive those values: EMAIL, PHONE, ADDRESS,COMPANYNAME, SECTOR, POSITION, DOCUMENT, RG, CPF, NAME, PLATETEXT, DROPDOWN, SCALE"},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT"],"description":"It’s an ENUM field that can receive those values: FIELD, FEEDBACK, MEETING_HOST, or MEETING_VISIT"},"customType":{"type":"boolean","description":"This value will be false when the field type is one of these types: EMAIL, PHONE, ADDRESS, COMPANYNAME, SECTOR, POSITION, DOCUMENT, RG, CPF, NAME, PLATE, and will be true when the field type is one of these: TEXT, DROPDOWN, SCALE."},"disabled":{"type":"boolean","description":"This value is false by default. However, this property can be used to change the field to read-only."},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for each option."},"name":{"type":"string","description":"The option response asked to the visitor."},"localizedName":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It is the asked option translations shown to the visit."}}},"description":"Values for the DROPDOWN options when the field type is DROPDOWN."},"customizationId":{"type":"string","description":"This is the company customization id."},"alwaysRequireInput":{"type":"boolean","description":"This value is false by default. However, this property can be used to make the field input be always requested for recurrent visitors."}}},"description":""},"disableQRCode":{"type":"boolean","description":"if true, the company will not use QRCode"},"metadata":{"type":"object","description":"Optional object"},"questionnaireEnabled":{"type":"boolean","description":"If true enable questionnaire at checkin and pre-checkin."},"questionnaireLastEdited":{"type":"string","description":"Date when the questionnaire was last edited."},"questionnaireVideoUrl":{"type":"string","description":"URL of a video on the questionnaire step."},"questionnaireValidForDays":{"type":"number","description":"How many days questionnaire is valid."},"sendVisitorEmailDeinedEnabled":{"type":"boolean","description":"If true, an automatic email will be sent to the user if it’s denied."},"sendVisitorWhatsappDeinedEnabled":{"type":"boolean","description":"If true, an automatic WhatsApp message will be sent to the user if it’s denied."},"timeToCheckinBeforeMeetingEnabled":{"type":"boolean","description":"If true, it will send an automatic email to the invitee allowing it to check in on their smartphone."},"timeToCheckinBeforeMeetingInHours":{"type":"number","description":"Time in hours before the meeting that the visit is allowed to check-in."},"automaticHostDesactivationEnabled":{"type":"boolean","description":"If true, it will inactivate all hosts from the company at midnight."},"phoneQuestionnaireEnabled":{"type":"boolean","description":"If true, it will allow the visit to finish their check-in on their own smartphone."},"hideLastNameEnabled":{"type":"boolean","description":"If true, hide the host's last name at check-in."},"takePictureOnlyOnKiosk":{"type":"boolean","description":"If true, the visit picture will be taken only on the kiosk. This config willl disable some checkin flows where is not possible to take a picture."},"enablePreCheckinByPrimaryKeyOnly":{"type":"boolean","description":"If true, allows pre-checkin by primaryKey only and hides pre-checkin infos of recurrent visitors."},"multiDayMeetingEnabled":{"type":"boolean","description":"If true, allows the meeting to start and end on different days."},"delayVisitEnabled":{"type":"boolean","description":"If true, allows to postpone the visit"},"showCheckoutButtonOnKiosk":{"type":"boolean","description":"If true, show the checkout button on the kiosk"},"sendPreCheckinQrCodeOnWhatsapp":{"type":"boolean","description":"If true, send the QR code on WhatsApp at pre-checkin"},"disableSignupAndLoginOnInvite":{"type":"boolean","description":"If true, the signup and login screens will not be shown when accessing the platform via an invite."}}},"customizations":{"title":"Customization","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"metadata":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true,"default":{}},"backgroundColor":{"type":"string","maxLength":7,"nullable":true},"mainColor":{"type":"string","maxLength":7,"nullable":true},"textColor":{"type":"string","maxLength":7,"nullable":true},"displayName":{"type":"string","nullable":true},"pictureUrl":{"type":"string","nullable":true},"feedbackEnabled":{"type":"boolean","default":false},"ipadMessage":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"ipadMessageSize":{"type":"integer","format":"int32","nullable":true},"ipadMessageAlign":{"type":"string","enum":["LEFT","CENTER","RIGHT"],"nullable":true},"ipadSlideshowImages":{"type":"array","items":{"type":"string"},"nullable":true},"ipadSlideshowDuration":{"type":"integer","format":"int32","nullable":true},"ipadLogoHeight":{"type":"integer","format":"int32","nullable":true},"ipadLogoTopHeight":{"type":"integer","format":"int32","nullable":true},"ipadSeeYouDuration":{"type":"integer","format":"int32","default":6},"ipadSeeYouMessage":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"ipadWelcomeDuration":{"type":"integer","format":"int32","default":6},"ipadWelcomeMessage":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"ipadWelcomeAwaitingAuthorizationMessage":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"signOutEnabled":{"type":"boolean","default":true},"authorizationEnabled":{"type":"boolean","default":false},"gdprEnabled":{"type":"boolean","default":false},"gdprAnonymouslyCheckin":{"type":"boolean","default":false},"deliveriesEnabled":{"type":"boolean","default":false},"deliveriesResponsibleHosts":{"type":"boolean","default":false},"ipadDeliveriesMessage":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"ipadDeliveriesDuration":{"type":"integer","format":"int32","default":6},"ipadDeliveriesDisplayAll":{"type":"boolean","default":false},"ipadDeliveriesIsPictureEnabled":{"type":"boolean","default":false},"blocklistEnabled":{"type":"boolean","default":false},"allowlistsEnabled":{"type":"boolean","nullable":true},"qrCodeCheckinEnabled":{"type":"boolean","default":true},"disableScreenTimer":{"type":"boolean","default":false},"isZoneAuthorizationEnabled":{"type":"boolean","default":false},"dashboardCheckin":{"type":"boolean","default":false},"dashboardNotification":{"type":"boolean","default":false},"inviteWithAccount":{"type":"boolean","default":false},"waccessIntegration":{"type":"boolean","default":false},"emailNotification":{"type":"boolean","default":true},"smsNotification":{"type":"boolean","default":false},"whatsappNotification":{"type":"boolean","default":false},"whatsappPlan":{"type":"string","nullable":true,"default":"INVITE_VISITOR_WHATSAPP_HOST_WHATSAPP"},"automaticCheckOutEnabled":{"type":"boolean","default":false},"automaticCheckOutHour":{"type":"integer","format":"int32","nullable":true},"isVisitsDeletionEnabled":{"type":"boolean","default":false},"deleteVisitsAfterDays":{"type":"integer","format":"int32","nullable":true},"companyId":{"type":"string","nullable":true},"disableQRCode":{"type":"boolean","nullable":true,"default":false},"sendVisitorEmailDeinedEnabled":{"type":"boolean","default":true},"sendVisitorWhatsappDeinedEnabled":{"type":"boolean","default":false},"timeToCheckinBeforeMeetingEnabled":{"type":"boolean","default":false},"timeToCheckinBeforeMeetingInHours":{"type":"integer","format":"int32","default":1},"automaticHostDesactivationEnabled":{"type":"boolean","default":false},"ipadTouchlessQRCodeEnable":{"type":"boolean","default":false},"ipadTouchlessShowQRCodeEnable":{"type":"boolean","default":false},"checkoutVisitWhenDeinedEnabled":{"type":"boolean","default":true},"ipadInstantCheckinEnabled":{"type":"boolean","default":false},"automaticallyPrintsVisitBadgeOnIpadId":{"type":"string","nullable":true},"sendVisitorCheckoutEmailToHostEnabled":{"type":"boolean","default":false},"ipadHideVisitorInfoEnable":{"type":"boolean","default":false},"translationId":{"type":"string","nullable":true},"mapAddressImgEnabled":{"type":"boolean","default":false},"canChangeMeetingTimeAfterCheckin":{"type":"boolean","default":true},"canViewHostEmailDuringInvite":{"type":"boolean","default":true},"pendingVisitNotificationEnable":{"type":"boolean","default":false},"pendingVisitNotificationTimeMinute":{"type":"integer","format":"int32","default":10},"viewInvitationsByTable":{"type":"boolean","default":false},"accessLevelEnabled":{"type":"boolean","nullable":true,"default":false},"takePictureOnlyOnKiosk":{"type":"boolean","nullable":true,"default":false},"enablePreCheckinByPrimaryKeyOnly":{"type":"boolean","nullable":true,"default":false},"multiDayMeetingEnabled":{"type":"boolean","nullable":true,"default":true},"delayVisitEnabled":{"type":"boolean","nullable":true,"default":false},"notifyDefaultHosts":{"type":"boolean","nullable":true,"default":false},"qrCodeCheckinAtHomeEnabled":{"type":"boolean","nullable":true},"showCheckoutButtonOnKiosk":{"type":"boolean","nullable":true,"default":true},"sendPreCheckinQrCodeOnWhatsapp":{"type":"boolean","nullable":true,"default":false},"visitorFacialEnabled":{"type":"boolean","nullable":true},"displayBypassRolesVisits":{"type":"boolean","nullable":true},"credentialingEnabled":{"type":"boolean","nullable":true},"disableSignupAndLoginOnInvite":{"type":"boolean","nullable":true},"showMeetingNotificationOnDashboard":{"type":"boolean","nullable":true},"documentOcrEnabled":{"type":"boolean","nullable":true},"documentOcrSaveImageEnabled":{"type":"boolean","nullable":true},"inactiveTimeMs":{"type":"number","nullable":true},"searchAllFlowTypes":{"type":"boolean","nullable":true}},"required":["id","createdAt","updatedAt","deletedAt","metadata","feedbackEnabled","ipadSeeYouDuration","ipadWelcomeDuration","signOutEnabled","authorizationEnabled","gdprEnabled","gdprAnonymouslyCheckin","deliveriesEnabled","deliveriesResponsibleHosts","ipadDeliveriesDuration","ipadDeliveriesDisplayAll","ipadDeliveriesIsPictureEnabled","blocklistEnabled","qrCodeCheckinEnabled","disableScreenTimer","isZoneAuthorizationEnabled","dashboardCheckin","dashboardNotification","inviteWithAccount","waccessIntegration","emailNotification","smsNotification","whatsappNotification","whatsappPlan","automaticCheckOutEnabled","isVisitsDeletionEnabled","disableQRCode","sendVisitorEmailDeinedEnabled","sendVisitorWhatsappDeinedEnabled","timeToCheckinBeforeMeetingEnabled","timeToCheckinBeforeMeetingInHours","automaticHostDesactivationEnabled","ipadTouchlessQRCodeEnable","ipadTouchlessShowQRCodeEnable","checkoutVisitWhenDeinedEnabled","ipadInstantCheckinEnabled","sendVisitorCheckoutEmailToHostEnabled","ipadHideVisitorInfoEnable","mapAddressImgEnabled","canChangeMeetingTimeAfterCheckin","canViewHostEmailDuringInvite","pendingVisitNotificationEnable","pendingVisitNotificationTimeMinute","viewInvitationsByTable","accessLevelEnabled","takePictureOnlyOnKiosk","enablePreCheckinByPrimaryKeyOnly","multiDayMeetingEnabled","delayVisitEnabled","notifyDefaultHosts","showCheckoutButtonOnKiosk","sendPreCheckinQrCodeOnWhatsapp"]},"customizations_list":{"title":"customizations list","type":"array","items":{"$ref":"#/components/schemas/customizations"}},"waccessAdd":{"type":"object","required":["aesKey","qrCodeDuration"],"properties":{"url":{"type":"string","description":"The URL used to send local requests."},"aesKey":{"type":"string","description":"The company AES key."},"username":{"type":"string","description":"The username used to authenticate the local requests."},"password":{"type":"string","description":"The password used to authenticate the local requests."},"qrCodeDuration":{"type":"number","description":"The dynamic QRCode duration in seconds."},"totpEnabled":{"type":"boolean","description":"Enable/disable TOTP feature for dynamic QRCodes"},"staticVisitorQRCode":{"type":"boolean","description":"Enable it to use static QRCode for the visit"},"companyId":{"type":"string","description":"This is the company id."}}},"waccessUpdate":{"type":"object","properties":{"url":{"type":"string","description":"The URL used to send local requests."},"aesKey":{"type":"string","description":"The company AES key."},"username":{"type":"string","description":"The username used to authenticate the local requests."},"password":{"type":"string","description":"The password used to authenticate the local requests."},"qrCodeDuration":{"type":"number","description":"The dynamic QRCode duration in seconds."},"totpEnabled":{"type":"boolean","description":"Enable/disable TOTP feature for dynamic QRCodes"},"staticVisitorQRCode":{"type":"boolean","description":"Enable it to use static QRCode for the visit"},"companyId":{"type":"string","description":"This is the company id."}}},"waccess-integrations":{"title":"Waccess_integration","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"companyId":{"type":"string"},"aesKey":{"type":"string"},"username":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"qrCodeDuration":{"type":"integer","format":"int32"},"url":{"type":"string"},"totpEnabled":{"type":"boolean","default":false},"staticVisitorQRCode":{"type":"boolean","default":false},"HIDMobileAccess":{"type":"boolean","nullable":true}},"required":["id","createdAt","updatedAt","deletedAt","companyId","aesKey","qrCodeDuration","url","totpEnabled","staticVisitorQRCode"]},"waccess-integrations_list":{"title":"waccess-integrations list","type":"array","items":{"$ref":"#/components/schemas/waccess-integrations"}},"meetingTypeAdd":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Meeting type name."},"description":{"type":"string","description":"Description meeting type"},"isPublic":{"type":"boolean","description":"If true, meeting type appear to all hosts when create meeting."},"isVisitApproved":{"type":"boolean","description":"If true Approve visit automatic."},"companyId":{"type":"string","description":"Company Id."},"sort":{"type":"number","description":"Use it to order the meeting types starting from 0, where 0 is the first one."},"placeholder":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown in the English meeting type."},"pt-BR":{"type":"string","description":"This is the placeholder text shown in the Portuguese meeting type."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown in the Chinese meeting type."}},"description":"It is the placeholder translations shown at the meeting types."}}},"meetingTypeUpdate":{"type":"object","properties":{"name":{"type":"string","description":"Meeting type name."},"description":{"type":"string","description":"Description meeting type"},"isPublic":{"type":"boolean","description":"If true, meeting type appear to all hosts when create meeting."},"isVisitApproved":{"type":"boolean","description":"If true Approve visit automatic."},"companyId":{"type":"string","description":"Company Id."},"sort":{"type":"number","description":"Use it to order the meeting types starting from 0, where 0 is the first one."},"placeholder":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown in the English meeting type."},"pt-BR":{"type":"string","description":"This is the placeholder text shown in the Portuguese meeting type."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown in the Chinese meeting type."}},"description":"It is the placeholder translations shown at the meeting types."}}},"meeting-types":{"title":"Meeting_type","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"name":{"type":"string"},"description":{"type":"string","nullable":true},"isPublic":{"type":"boolean","default":true},"isVisitApproved":{"type":"boolean","default":true},"sort":{"type":"integer","format":"int32","default":0},"placeholder":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"companyId":{"type":"string"},"type":{"type":"string","default":"default"},"preCheckinByHostEnabled":{"type":"boolean","nullable":true},"disableSubject":{"type":"boolean","nullable":true},"disableLanguage":{"type":"boolean","nullable":true},"disableDate":{"type":"boolean","nullable":true},"disableTime":{"type":"boolean","nullable":true},"disableGuests":{"type":"boolean","nullable":true},"disableCoHosts":{"type":"boolean","nullable":true},"disableLocation":{"type":"boolean","nullable":true},"disableMessage":{"type":"boolean","nullable":true},"disableNotes":{"type":"boolean","nullable":true},"disableHost":{"type":"boolean","nullable":true},"hideMeetingDetails":{"type":"boolean","nullable":true,"default":false}},"required":["id","createdAt","updatedAt","deletedAt","name","isPublic","isVisitApproved","sort","companyId","type","hideMeetingDetails"]},"meeting-types_list":{"title":"meeting-types list","type":"array","items":{"$ref":"#/components/schemas/meeting-types"}},"customFieldAdd":{"type":"object","required":["id","name","sort","type","location"],"properties":{"id":{"type":"string","description":"Unique identifier for the custom field."},"name":{"type":"string","description":"The question asked to the visitor."},"required":{"type":"boolean","description":"If true, this field is mandatory for the visitor. Default: false."},"sort":{"type":"number","description":"This serves to order the custom fields starting from 0, where 0 is for the first field shown."},"placeholder":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It is the placeholder translations shown to the visit."},"type":{"type":"string","enum":["EMAIL","PHONE","ADDRESS","COMPANYNAME","SECTOR","POSITION","DOCUMENT","RG","CPF","NAME","PLATE","TEXT","DROPDOWN","SCALE"],"description":"It’s an ENUM field that can receive those values: EMAIL, PHONE, ADDRESS,COMPANYNAME, SECTOR, POSITION, DOCUMENT, RG, CPF, NAME, PLATETEXT, DROPDOWN, SCALE"},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT"],"description":"It’s an ENUM field that can receive those values: FIELD, FEEDBACK, MEETING_HOST, or MEETING_VISIT"},"customType":{"type":"boolean","description":"This value will be false when the field type is one of these types: EMAIL, PHONE, ADDRESS, COMPANYNAME, SECTOR, POSITION, DOCUMENT, RG, CPF, NAME, PLATE, and will be true when the field type is one of these: TEXT, DROPDOWN, SCALE."},"disabled":{"type":"boolean","description":"This value is false by default. However, this property can be used to change the field to read-only."},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for each option."},"name":{"type":"string","description":"The option response asked to the visitor."},"localizedName":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It is the asked option translations shown to the visit."}}},"description":"Values for the DROPDOWN options when the field type is DROPDOWN."},"customizationId":{"type":"string","description":"This is the company customization id."},"alwaysRequireInput":{"type":"boolean","description":"This value is false by default. However, this property can be used to make the field input be always requested for recurrent visitors."}}},"customFieldUpdate":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the custom field."},"name":{"type":"string","description":"The question asked to the visitor."},"required":{"type":"boolean","description":"If true, this field is mandatory for the visitor. Default: false."},"sort":{"type":"number","description":"This serves to order the custom fields starting from 0, where 0 is for the first field shown."},"placeholder":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It is the placeholder translations shown to the visit."},"type":{"type":"string","enum":["EMAIL","PHONE","ADDRESS","COMPANYNAME","SECTOR","POSITION","DOCUMENT","RG","CPF","NAME","PLATE","TEXT","DROPDOWN","SCALE"],"description":"It’s an ENUM field that can receive those values: EMAIL, PHONE, ADDRESS,COMPANYNAME, SECTOR, POSITION, DOCUMENT, RG, CPF, NAME, PLATETEXT, DROPDOWN, SCALE"},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT"],"description":"It’s an ENUM field that can receive those values: FIELD, FEEDBACK, MEETING_HOST, or MEETING_VISIT"},"customType":{"type":"boolean","description":"This value will be false when the field type is one of these types: EMAIL, PHONE, ADDRESS, COMPANYNAME, SECTOR, POSITION, DOCUMENT, RG, CPF, NAME, PLATE, and will be true when the field type is one of these: TEXT, DROPDOWN, SCALE."},"disabled":{"type":"boolean","description":"This value is false by default. However, this property can be used to change the field to read-only."},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for each option."},"name":{"type":"string","description":"The option response asked to the visitor."},"localizedName":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It is the asked option translations shown to the visit."}}},"description":"Values for the DROPDOWN options when the field type is DROPDOWN."},"customizationId":{"type":"string","description":"This is the company customization id."},"alwaysRequireInput":{"type":"boolean","description":"This value is false by default. However, this property can be used to make the field input be always requested for recurrent visitors."}}},"custom-fields":{"title":"Custom_field","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"name":{"type":"string"},"required":{"type":"boolean","default":false},"sort":{"type":"integer","format":"int32"},"placeholder":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"type":{"type":"string","enum":["EMAIL","PHONE","ADDRESS","COMPANYNAME","SECTOR","POSITION","DOCUMENT","RG","CPF","NAME","PLATE","TEXT","DROPDOWN","SCALE","IDENTITY_CARD","BOOLEAN","CHOSEN_NAME","HOST_NAME","HOST_EMAIL","HOST_PHONE","VISIT_REASON"]},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT","QUESTIONNAIRE","HOST_EXTRA_INFO"]},"customType":{"type":"boolean","nullable":true},"options":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"disabled":{"type":"boolean","default":false},"customizationId":{"type":"string","nullable":true},"displayLocation":{"type":"string","enum":["ALL","KIOSK","INVITES"]},"alwaysRequireInput":{"type":"boolean","default":false},"visitFlowTypeId":{"type":"string","nullable":true},"validationExpression":{"type":"string","nullable":true}},"required":["id","createdAt","updatedAt","deletedAt","name","required","sort","type","location","disabled","displayLocation","alwaysRequireInput"]},"custom-fields_list":{"title":"custom-fields list","type":"array","items":{"$ref":"#/components/schemas/custom-fields"}},"hostMeetingTypeAdd":{"type":"object","required":["hostId","meetingTypeId"],"properties":{"hostId":{"type":"string","description":"Host Id."},"meetingTypeId":{"type":"string","description":"Meeting Type Id"}}},"hosts-meeting-types":{"title":"Hosts_meeting_type","type":"object","properties":{"id":{"type":"integer","format":"int32"},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"hostId":{"type":"string"},"meetingTypeId":{"type":"string"}},"required":["id","createdAt","updatedAt","hostId","meetingTypeId"]},"hosts-meeting-types_list":{"title":"hosts-meeting-types list","type":"array","items":{"$ref":"#/components/schemas/hosts-meeting-types"}},"meetingTypeCustomFieldAdd":{"type":"object","required":["customFieldsId","meetingTypeId"],"properties":{"customFieldsId":{"type":"string","description":"Custom field id."},"meetingTypeId":{"type":"string","description":"Meeting type id."}}},"meeting-types-custom-fields":{"title":"Meeting_types_custom_field","type":"object","properties":{"id":{"type":"integer","format":"int32"},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"customFieldsId":{"type":"string"},"meetingTypeId":{"type":"string"}},"required":["id","createdAt","updatedAt","customFieldsId","meetingTypeId"]},"meeting-types-custom-fields_list":{"title":"meeting-types-custom-fields list","type":"array","items":{"$ref":"#/components/schemas/meeting-types-custom-fields"}},"meetingLocationsAdd":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Meeting location name."},"description":{"type":"string","description":"Meeting location description."},"pictureUrl":{"type":"string","description":"Meeting location map image url."},"companyId":{"type":"string","description":"Comapny Id."}}},"meetingLocationsUpdate":{"type":"object","properties":{"name":{"type":"string","description":"Meeting location name."},"description":{"type":"string","description":"Meeting location description."},"pictureUrl":{"type":"string","description":"Meeting location map image url."},"companyId":{"type":"string","description":"Comapny Id."}}},"meeting-locations":{"title":"Meeting_location","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"name":{"type":"string"},"description":{"type":"string","nullable":true},"pictureUrl":{"type":"string","nullable":true},"companyId":{"type":"string"}},"required":["id","createdAt","updatedAt","deletedAt","name","companyId"]},"meeting-locations_list":{"title":"meeting-locations list","type":"array","items":{"$ref":"#/components/schemas/meeting-locations"}},"NotificationHostsAdd":{"type":"object","required":["hostId","notificationId"],"properties":{"hostId":{"type":"string","description":"The host id."},"notificationId":{"type":"string","description":"The notification id."}}},"NotificationHostsUpdate":{"type":"object","properties":{"hostId":{"type":"string","description":"The host id."},"notificationId":{"type":"string","description":"The notification id."}}},"notification-hosts":{"title":"Notification_host","type":"object","properties":{"id":{"type":"string","nullable":true,"default":{}},"notificationId":{"type":"string","nullable":true},"hostId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","createdAt","updatedAt"]},"notification-hosts_list":{"title":"notification-hosts list","type":"array","items":{"$ref":"#/components/schemas/notification-hosts"}},"hostZoneAdd":{"type":"object","required":["hostId","zoneId"],"properties":{"hostId":{"type":"string","description":"Host Id."},"zoneId":{"type":"string","description":"Zone Id"}}},"host-zones":{"title":"Host_zone","type":"object","properties":{"id":{"type":"integer","format":"int32"},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"hostId":{"type":"string"},"zoneId":{"type":"string"}},"required":["id","createdAt","updatedAt","hostId","zoneId"]},"host-zones_list":{"title":"host-zones list","type":"array","items":{"$ref":"#/components/schemas/host-zones"}},"zoneslistFind":{"type":"array","required":[],"items":{"properties":{"name":{"type":"string","description":"The zone name."},"companyId":{"type":"string","description":"The id of company."}}}},"zonelistGet":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The zone name."},"companyId":{"type":"string","description":"The id of company."}}},"zoneAdd":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The zone name."},"companyId":{"type":"string","description":"The id of company."}}},"zoneUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The zone name."},"companyId":{"type":"string","description":"The id of company."}}},"zones":{"title":"Zone","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"name":{"type":"string"},"companyId":{"type":"string"},"endpointUrl":{"type":"string","nullable":true},"littleEndianFormatEnabled":{"type":"boolean","nullable":true},"username":{"type":"string","nullable":true},"password":{"type":"string","nullable":true}},"required":["id","createdAt","updatedAt","deletedAt","name","companyId"]},"zones_list":{"title":"zones list","type":"array","items":{"$ref":"#/components/schemas/zones"}},"meeting-types-zones":{"title":"Meeting_types_zone","type":"object","properties":{"id":{"type":"integer","format":"int32"},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"meetingTypeId":{"type":"string"},"zoneId":{"type":"string"}},"required":["id","createdAt","updatedAt","meetingTypeId","zoneId"]},"meeting-types-zones_list":{"title":"meeting-types-zones list","type":"array","items":{"$ref":"#/components/schemas/meeting-types-zones"}},"childrenVisitsFind":{"type":"object","properties":{"id":{"type":"string","description":"UUIDv4."},"hostId":{"type":"string","description":"The host you will be visiting on."},"checkinType":{"type":"string","enum":["IPAD","DASHBOARD","API","MOBILE"],"description":"One of IPAD, DASHBOARD, API, MOBILE."},"checkoutType":{"type":"string","enum":["IPAD","DASHBOARD","API","MOBILE"],"description":"One of IPAD, DASHBOARD, API, MOBILE."},"cardNumber":{"type":"string","description":"The visitor card number used to integrate with ticket gates."},"expectedAt":{"type":"string","description":"The expected date when the visitor has an invite."},"checkinAt":{"type":"string","description":"Check-in date."},"finishCheckinAt":{"type":"string","description":"The date the visitor finished the check-in."},"checkoutAt":{"type":"string","description":"Check-out date."},"authorizedById":{"type":"string","description":"The id of the host who authorized the visit."},"authorizedAt":{"type":"string","description":"The date that the visit was allowed or denied."},"authorizationVia":{"type":"string","enum":["DASHBOARD","INVITE","LINK","APP","W-ACCESS"],"description":"Location to which the visit was approved. One of DASHBOARD, INVITE, LINK, APP."},"authorizationLink":{"type":"string","description":"Link sent to the host to allow or deny the visit."},"authorizationStatus":{"type":"string","enum":["AWAITING","ALLOWED","DENIED"],"description":"What is the authorization status of the visit. One of AWAITING, ALLOWED, DENIED."},"checkinByHostId":{"type":"string","description":"Id of the host that the visitor has checked-in."},"checkinByIpadId":{"type":"string","description":"Id of the iPad that the visitor has checked-in."},"checkoutByHostId":{"type":"string","description":"Id of the host that the visitor has checked-out."},"checkoutByIpadId":{"type":"string","description":"Id of the iPad that the visitor has checked-out."},"notes":{"type":"string","description":"Notes about this visit."},"customHostName":{"type":"string","description":"Custom host name when the company allows it."},"meetingId":{"type":"string","description":"The id of the meeting this visit was invited to."},"companyId":{"type":"string","description":"The id of the company."},"visitorId":{"type":"string","description":"The id of the visitor."},"userId":{"type":"string","description":"The id of the user linked to this visit."},"isCanceled":{"type":"boolean","description":"It indicates if the visit is canceled after pre-check-in and before check-in"},"feedbacks":{"type":"array","items":{"type":"object","required":["customFieldId","value"],"properties":{"customFieldId":{"type":"string","description":"Id of the custom field."},"isCorrect":{"type":"boolean","description":"Only used for questionnaire fields to indicate if it was correct or not"},"name":{"type":"string","description":"The question."},"localizedName":{"type":"object","properties":{"en":{"type":"string","description":"This is the English question translation."},"pt-BR":{"type":"string","description":"This is the Portuguese question translation."},"zh-Hans":{"type":"string","description":"This is the Chinese question translation."}},"description":"The translation of the question."},"localizedValue":{"type":"object","properties":{"en":{"type":"string","description":"This is the English answer translation."},"pt-BR":{"type":"string","description":"This is the Portuguese answer translation."},"zh-Hans":{"type":"string","description":"This is the Chinese answer translation."}},"description":"The translation of the question answer."},"sort":{"type":"number","description":"This serves to order the custom fields starting from 0, where 0 is for the first field shown."},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT","QUESTIONNAIRE","HOST_EXTRA_INFO"],"description":"The type of the custom field"},"value":{"type":"string","description":"The question answer."},"visitorId":{"type":"string","description":"Id of the visitor who answered the question."},"visitId":{"type":"string","description":"Id of the visit who answered the question."},"meetingId":{"type":"string","description":"If the question is in meeting, add the meeting id."}}},"description":"List of values of feedbacks."},"customFields":{"type":"array","items":{"type":"object","required":["customFieldId","value"],"properties":{"customFieldId":{"type":"string","description":"Id of the custom field."},"isCorrect":{"type":"boolean","description":"Only used for questionnaire fields to indicate if it was correct or not"},"name":{"type":"string","description":"The question."},"localizedName":{"type":"object","properties":{"en":{"type":"string","description":"This is the English question translation."},"pt-BR":{"type":"string","description":"This is the Portuguese question translation."},"zh-Hans":{"type":"string","description":"This is the Chinese question translation."}},"description":"The translation of the question."},"localizedValue":{"type":"object","properties":{"en":{"type":"string","description":"This is the English answer translation."},"pt-BR":{"type":"string","description":"This is the Portuguese answer translation."},"zh-Hans":{"type":"string","description":"This is the Chinese answer translation."}},"description":"The translation of the question answer."},"sort":{"type":"number","description":"This serves to order the custom fields starting from 0, where 0 is for the first field shown."},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT","QUESTIONNAIRE","HOST_EXTRA_INFO"],"description":"The type of the custom field"},"value":{"type":"string","description":"The question answer."},"visitorId":{"type":"string","description":"Id of the visitor who answered the question."},"visitId":{"type":"string","description":"Id of the visit who answered the question."},"meetingId":{"type":"string","description":"If the question is in meeting, add the meeting id."}}},"description":"List of values of custom fields"},"questionnaireFields":{"type":"array","items":{"type":"object","required":["customFieldId","value"],"properties":{"customFieldId":{"type":"string","description":"Id of the custom field."},"isCorrect":{"type":"boolean","description":"Only used for questionnaire fields to indicate if it was correct or not"},"name":{"type":"string","description":"The question."},"localizedName":{"type":"object","properties":{"en":{"type":"string","description":"This is the English question translation."},"pt-BR":{"type":"string","description":"This is the Portuguese question translation."},"zh-Hans":{"type":"string","description":"This is the Chinese question translation."}},"description":"The translation of the question."},"localizedValue":{"type":"object","properties":{"en":{"type":"string","description":"This is the English answer translation."},"pt-BR":{"type":"string","description":"This is the Portuguese answer translation."},"zh-Hans":{"type":"string","description":"This is the Chinese answer translation."}},"description":"The translation of the question answer."},"sort":{"type":"number","description":"This serves to order the custom fields starting from 0, where 0 is for the first field shown."},"location":{"type":"string","enum":["FIELD","FEEDBACK","MEETING_HOST","MEETING_VISIT","QUESTIONNAIRE","HOST_EXTRA_INFO"],"description":"The type of the custom field"},"value":{"type":"string","description":"The question answer."},"visitorId":{"type":"string","description":"Id of the visitor who answered the question."},"visitId":{"type":"string","description":"Id of the visit who answered the question."},"meetingId":{"type":"string","description":"If the question is in meeting, add the meeting id."}}},"description":"List of values of questionnaire fields"},"firstAccessAt":{"type":"string","description":"First Access date."},"timeToDelayVisit":{"type":"Date","description":"Date will the visit be postponed"}}},"children":{"title":"Visits_history","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"cardNumber":{"type":"string","nullable":true},"expectedAt":{"type":"string","format":"date-time","nullable":true},"expectedOutAt":{"type":"string","format":"date-time","nullable":true},"checkinAt":{"type":"string","format":"date-time","nullable":true},"checkinType":{"type":"string","enum":["IPAD","DASHBOARD","API","MOBILE","INVITES","AUTOMATIC"],"nullable":true},"checkoutType":{"type":"string","enum":["IPAD","DASHBOARD","API","MOBILE","INVITES","AUTOMATIC"],"nullable":true},"finishCheckinAt":{"type":"string","format":"date-time","nullable":true},"checkoutAt":{"type":"string","format":"date-time","nullable":true},"authorizedById":{"type":"string","nullable":true},"authorizedAt":{"type":"string","format":"date-time","nullable":true},"authorizationVia":{"type":"string","enum":["DASHBOARD","INVITE","LINK","APP","W-ACCESS"],"nullable":true},"authorizationLink":{"type":"string","nullable":true},"authorizationStatus":{"type":"string","enum":["AWAITING","ALLOWED","DENIED"],"nullable":true},"checkinByHostId":{"type":"string","nullable":true},"checkinByIpadId":{"type":"string","nullable":true},"checkoutByHostId":{"type":"string","nullable":true},"checkoutByIpadId":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"customHostName":{"type":"string","nullable":true},"hostId":{"type":"string","nullable":true},"meetingId":{"type":"string","nullable":true},"companyId":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true},"lang":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"cpf":{"type":"string","nullable":true},"rg":{"type":"string","nullable":true},"document":{"type":"string","nullable":true},"companyname":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"position":{"type":"string","nullable":true},"plate":{"type":"string","nullable":true},"sector":{"type":"string","nullable":true},"pictureUrl":{"type":"string","nullable":true},"pictureMediumUrl":{"type":"string","nullable":true},"pictureThumbUrl":{"type":"string","nullable":true},"ndaUrl":{"type":"string","nullable":true},"metadata":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"retakePicture":{"type":"boolean","default":false},"ndaSignedAt":{"type":"string","format":"date-time","nullable":true},"questionnaireAnsweredAt":{"type":"string","format":"date-time","nullable":true},"isCanceled":{"type":"boolean","default":false},"identity_card":{"type":"string","nullable":true},"isForeigner":{"type":"boolean","nullable":true},"chosen_name":{"type":"string","nullable":true},"gdprAgreedAt":{"type":"string","format":"date-time","nullable":true},"isAnonymous":{"type":"boolean","default":false},"invenziId":{"type":"string","nullable":true},"mifareCardNumber":{"type":"string","nullable":true},"smsOtpValidationId":{"type":"string","nullable":true},"firstAccessAt":{"type":"string","format":"date-time","nullable":true},"accessLevelId":{"type":"string","nullable":true},"timeToDelayVisit":{"type":"string","format":"date-time","nullable":true},"visitorNoteDenied":{"type":"string","nullable":true},"credentialedVisit":{"type":"boolean","nullable":true},"visitFlowTypeId":{"type":"string"}},"required":["id","createdAt","updatedAt","deletedAt","retakePicture","isCanceled","isAnonymous","visitFlowTypeId"]},"children_list":{"title":"children list","type":"array","items":{"$ref":"#/components/schemas/children"}},"access-levels":{"title":"Access_level","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"name":{"type":"string","nullable":true},"companyId":{"type":"string","nullable":true}},"required":["id","createdAt","updatedAt","deletedAt"]},"access-levels_list":{"title":"access-levels list","type":"array","items":{"$ref":"#/components/schemas/access-levels"}},"meetingConfigsCreate":{"type":"object","required":["meetingId"],"properties":{"meetingId":{"type":"string","description":"This is the meeting id"},"sendVisitWhatsapp":{"type":"boolean"},"sendVisitEmail":{"type":"boolean"}}},"meetingConfigsUpdate":{"type":"object","properties":{"meetingId":{"type":"string","description":"This is the meeting id"},"sendVisitWhatsapp":{"type":"boolean"},"sendVisitEmail":{"type":"boolean"}}},"meeting-configs":{"title":"Meeting_config","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"sendVisitEmail":{"type":"boolean","nullable":true},"sendVisitWhatsapp":{"type":"boolean","nullable":true},"sendHostEmail":{"type":"boolean","nullable":true},"sendHostWhatsapp":{"type":"boolean","nullable":true},"meetingId":{"type":"string"}},"required":["id","createdAt","updatedAt","deletedAt","meetingId"]},"meeting-configs_list":{"title":"meeting-configs list","type":"array","items":{"$ref":"#/components/schemas/meeting-configs"}},"visitFlowTypeAdd":{"type":"object","required":["name","companyId"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the visit flow type"},"name":{"type":"string","description":"Name of the visit flow type"},"companyId":{"type":"string","format":"uuid","description":"Company ID associated with the visit flow type"},"isEnabled":{"type":"boolean","description":"Indicates if the visit flow type is enabled"},"sort":{"type":"number","description":"This serves to order the visit flow types starting from 0, where 0 is for the first field shown."},"placeholder":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It is the placeholder translations shown to the visit."},"hostEnabled":{"type":"boolean","description":"If true, allows to choose a host for the visit"},"hostDisplayAll":{"type":"boolean","description":"If true, displays all hosts for the visitor"},"hostVisitorCanAdd":{"type":"boolean","description":"If true, allows the visitor to add a host"},"nameRequired":{"type":"boolean","description":"If true, name will be require to fulfill check-in flow"},"fullNameRequired":{"type":"boolean","description":"If true, full name will be require to fulfill check-in flow"},"namePlaceholder":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It is the placeholder translations for the name field."},"primaryKey":{"type":"string","enum":["EMAIL","PHONE","CPF","RG","DOCUMENT"],"description":"Can be one the types: \"EMAIL, PHONE, CPF, RG, DOCUMENT\"."},"primaryKeyPlaceholder":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It's the placeholder translations for the primary key field."},"ndaEnabled":{"type":"boolean","description":"If true, NDA will be required to fulfill check-in Flow"},"ndaLastEdited":{"type":"string","description":"Last edited date of the NDA"},"ndaValidForDays":{"type":"number","description":"Number of days which the NDA will be valid for."},"pictureEnabled":{"type":"boolean","description":"If false, it is not necessary to take picture."},"pictureUnique":{"type":"boolean","description":"If true, the visitor's picture will be taken only once and reused on each visit."},"pictureCanSkip":{"type":"boolean","description":"If true, visitors can skip picture while doing a check-in."},"uniqueVisitEnabled":{"type":"boolean","description":"If true, allows only one visit (without check-out) per visitor"},"questionnaireEnabled":{"type":"boolean","description":"If true enable questionnaire at checkin and pre-checkin."},"questionnaireLastEdited":{"type":"string","description":"Date when the questionnaire was last edited."},"questionnaireVideoUrl":{"type":"string","description":"URL of a video on the questionnaire step."},"questionnaireValidForDays":{"type":"number","description":"How many days questionnaire responses will be valid for."},"questionnaireVideoDescription":{"type":"string","description":"Description of the video on the questionnaire step."},"hideLastNameEnabled":{"type":"boolean","description":"If true, hide the host's last name at check-in."},"numberOfCharacters":{"type":"number","description":"Number of characters for the identity card"},"otpValidationEnable":{"type":"boolean","description":"If true, enables OTP validation for the visitor"},"otpValidationTimeToExpireInMinutes":{"type":"number","description":"Time in minutes for the OTP to expire"},"displayHostExtraInfoForm":{"type":"boolean","description":"If true, displays the host extra info form at check-in"},"takePictureOnlyOnKiosk":{"type":"boolean","description":"If true, the visit picture will be taken only on the kiosk. This config willl disable some checkin flows where is not possible to take a picture."}}},"visitFlowTypeUpdate":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the visit flow type"},"name":{"type":"string","description":"Name of the visit flow type"},"companyId":{"type":"string","format":"uuid","description":"Company ID associated with the visit flow type"},"isEnabled":{"type":"boolean","description":"Indicates if the visit flow type is enabled"},"sort":{"type":"number","description":"This serves to order the visit flow types starting from 0, where 0 is for the first field shown."},"placeholder":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It is the placeholder translations shown to the visit."},"hostEnabled":{"type":"boolean","description":"If true, allows to choose a host for the visit"},"hostDisplayAll":{"type":"boolean","description":"If true, displays all hosts for the visitor"},"hostVisitorCanAdd":{"type":"boolean","description":"If true, allows the visitor to add a host"},"nameRequired":{"type":"boolean","description":"If true, name will be require to fulfill check-in flow"},"fullNameRequired":{"type":"boolean","description":"If true, full name will be require to fulfill check-in flow"},"namePlaceholder":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It is the placeholder translations for the name field."},"primaryKey":{"type":"string","enum":["EMAIL","PHONE","CPF","RG","DOCUMENT"],"description":"Can be one the types: \"EMAIL, PHONE, CPF, RG, DOCUMENT\"."},"primaryKeyPlaceholder":{"type":"object","properties":{"en":{"type":"string","description":"This is the placeholder text shown to English visit."},"pt-BR":{"type":"string","description":"This is the placeholder text shown to Portuguese visit."},"zh-Hans":{"type":"string","description":"This is the placeholder text shown to Chinese visit."}},"description":"It's the placeholder translations for the primary key field."},"ndaEnabled":{"type":"boolean","description":"If true, NDA will be required to fulfill check-in Flow"},"ndaLastEdited":{"type":"string","description":"Last edited date of the NDA"},"ndaValidForDays":{"type":"number","description":"Number of days which the NDA will be valid for."},"pictureEnabled":{"type":"boolean","description":"If false, it is not necessary to take picture."},"pictureUnique":{"type":"boolean","description":"If true, the visitor's picture will be taken only once and reused on each visit."},"pictureCanSkip":{"type":"boolean","description":"If true, visitors can skip picture while doing a check-in."},"uniqueVisitEnabled":{"type":"boolean","description":"If true, allows only one visit (without check-out) per visitor"},"questionnaireEnabled":{"type":"boolean","description":"If true enable questionnaire at checkin and pre-checkin."},"questionnaireLastEdited":{"type":"string","description":"Date when the questionnaire was last edited."},"questionnaireVideoUrl":{"type":"string","description":"URL of a video on the questionnaire step."},"questionnaireValidForDays":{"type":"number","description":"How many days questionnaire responses will be valid for."},"questionnaireVideoDescription":{"type":"string","description":"Description of the video on the questionnaire step."},"hideLastNameEnabled":{"type":"boolean","description":"If true, hide the host's last name at check-in."},"numberOfCharacters":{"type":"number","description":"Number of characters for the identity card"},"otpValidationEnable":{"type":"boolean","description":"If true, enables OTP validation for the visitor"},"otpValidationTimeToExpireInMinutes":{"type":"number","description":"Time in minutes for the OTP to expire"},"displayHostExtraInfoForm":{"type":"boolean","description":"If true, displays the host extra info form at check-in"},"takePictureOnlyOnKiosk":{"type":"boolean","description":"If true, the visit picture will be taken only on the kiosk. This config willl disable some checkin flows where is not possible to take a picture."}}},"visit-flow-types":{"title":"Visit_flow_type","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"name":{"type":"string"},"isEnabled":{"type":"boolean","default":true},"sort":{"type":"integer","format":"int32","default":0},"placeholder":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"companyId":{"type":"string"},"hostEnabled":{"type":"boolean","default":true},"hostDisplayAll":{"type":"boolean","default":true},"hostVisitorCanAdd":{"type":"boolean","default":false},"nameRequired":{"type":"boolean","default":true},"fullNameRequired":{"type":"boolean","default":true},"namePlaceholder":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"primaryKey":{"type":"string","enum":["EMAIL","PHONE","CPF","RG","DOCUMENT"],"default":"PHONE"},"primaryKeyPlaceholder":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"ndaEnabled":{"type":"boolean","default":false},"ndaLastEdited":{"type":"string","format":"date-time","nullable":true},"ndaValidForDays":{"type":"integer","format":"int32","nullable":true},"pictureEnabled":{"type":"boolean","default":true},"pictureUnique":{"type":"boolean","default":false},"pictureCanSkip":{"type":"boolean","default":false},"uniqueVisitEnabled":{"type":"boolean","default":false},"questionnaireEnabled":{"type":"boolean","default":false},"questionnaireLastEdited":{"type":"string","format":"date-time","nullable":true},"questionnaireVideoUrl":{"type":"string","default":""},"questionnaireValidForDays":{"type":"integer","format":"int32","nullable":true},"questionnaireVideoDescription":{"type":"string","nullable":true},"hideLastNameEnabled":{"type":"boolean","default":false},"numberOfCharacters":{"type":"integer","format":"int32","nullable":true},"otpValidationEnable":{"type":"boolean","default":false},"otpValidationTimeToExpireInMinutes":{"type":"integer","format":"int32","nullable":true},"displayHostExtraInfoForm":{"type":"boolean","nullable":true,"default":false},"hideForeignerFlow":{"type":"boolean","nullable":true,"default":false},"serproValidationEnabled":{"type":"boolean","nullable":true},"serproCoHostValidationEnabled":{"type":"boolean","nullable":true},"allowPrintingWithoutCardNumber":{"type":"boolean","nullable":true},"displayWelcomeMessage":{"type":"boolean","nullable":true,"default":true},"extraSuccessScreenEnabled":{"type":"boolean","nullable":true},"requirePrinterCardNumberConfirmation":{"type":"boolean","nullable":true},"ipadPrintSuccessMessage":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"ipadWaitingForPrinterMessage":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"printSuccessTimeoutMs":{"type":"integer","format":"int32","nullable":true},"printerWaitTimeoutMs":{"type":"integer","format":"int32","nullable":true},"printerXML":{"type":"string","nullable":true}},"required":["id","createdAt","updatedAt","deletedAt","name","isEnabled","sort","companyId","hostEnabled","hostDisplayAll","hostVisitorCanAdd","nameRequired","fullNameRequired","primaryKey","ndaEnabled","pictureEnabled","pictureUnique","pictureCanSkip","uniqueVisitEnabled","questionnaireEnabled","questionnaireVideoUrl","hideLastNameEnabled","otpValidationEnable","displayHostExtraInfoForm","hideForeignerFlow","displayWelcomeMessage"]},"visit-flow-types_list":{"title":"visit-flow-types list","type":"array","items":{"$ref":"#/components/schemas/visit-flow-types"}},"allowlistAdd":{"type":"object","required":[],"properties":{"companyId":{"type":"string","description":"This is the company id"},"name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"document":{"type":"string"},"cpf":{"type":"string"},"rg":{"type":"string"}}},"allowlistUpdate":{"type":"object","properties":{"companyId":{"type":"string","description":"This is the company id"},"name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"document":{"type":"string"},"cpf":{"type":"string"},"rg":{"type":"string"}}},"allowlists":{"title":"Allowlist","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"name":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"document":{"type":"string","nullable":true},"cpf":{"type":"string","nullable":true},"rg":{"type":"string","nullable":true},"companyId":{"type":"string"}},"required":["id","createdAt","updatedAt","deletedAt","companyId"]},"allowlists_list":{"title":"allowlists list","type":"array","items":{"$ref":"#/components/schemas/allowlists"}},"visits-history":{"title":"Visits_history","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"cardNumber":{"type":"string","nullable":true},"expectedAt":{"type":"string","format":"date-time","nullable":true},"expectedOutAt":{"type":"string","format":"date-time","nullable":true},"checkinAt":{"type":"string","format":"date-time","nullable":true},"checkinType":{"type":"string","enum":["IPAD","DASHBOARD","API","MOBILE","INVITES","AUTOMATIC"],"nullable":true},"checkoutType":{"type":"string","enum":["IPAD","DASHBOARD","API","MOBILE","INVITES","AUTOMATIC"],"nullable":true},"finishCheckinAt":{"type":"string","format":"date-time","nullable":true},"checkoutAt":{"type":"string","format":"date-time","nullable":true},"authorizedById":{"type":"string","nullable":true},"authorizedAt":{"type":"string","format":"date-time","nullable":true},"authorizationVia":{"type":"string","enum":["DASHBOARD","INVITE","LINK","APP","W-ACCESS"],"nullable":true},"authorizationLink":{"type":"string","nullable":true},"authorizationStatus":{"type":"string","enum":["AWAITING","ALLOWED","DENIED"],"nullable":true},"checkinByHostId":{"type":"string","nullable":true},"checkinByIpadId":{"type":"string","nullable":true},"checkoutByHostId":{"type":"string","nullable":true},"checkoutByIpadId":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"customHostName":{"type":"string","nullable":true},"hostId":{"type":"string","nullable":true},"meetingId":{"type":"string","nullable":true},"companyId":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true},"lang":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"cpf":{"type":"string","nullable":true},"rg":{"type":"string","nullable":true},"document":{"type":"string","nullable":true},"companyname":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"position":{"type":"string","nullable":true},"plate":{"type":"string","nullable":true},"sector":{"type":"string","nullable":true},"pictureUrl":{"type":"string","nullable":true},"pictureMediumUrl":{"type":"string","nullable":true},"pictureThumbUrl":{"type":"string","nullable":true},"ndaUrl":{"type":"string","nullable":true},"metadata":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"retakePicture":{"type":"boolean","default":false},"ndaSignedAt":{"type":"string","format":"date-time","nullable":true},"questionnaireAnsweredAt":{"type":"string","format":"date-time","nullable":true},"isCanceled":{"type":"boolean","default":false},"identity_card":{"type":"string","nullable":true},"isForeigner":{"type":"boolean","nullable":true},"chosen_name":{"type":"string","nullable":true},"gdprAgreedAt":{"type":"string","format":"date-time","nullable":true},"isAnonymous":{"type":"boolean","default":false},"invenziId":{"type":"string","nullable":true},"mifareCardNumber":{"type":"string","nullable":true},"smsOtpValidationId":{"type":"string","nullable":true},"firstAccessAt":{"type":"string","format":"date-time","nullable":true},"accessLevelId":{"type":"string","nullable":true},"timeToDelayVisit":{"type":"string","format":"date-time","nullable":true},"visitorNoteDenied":{"type":"string","nullable":true},"credentialedVisit":{"type":"boolean","nullable":true},"visitFlowTypeId":{"type":"string"}},"required":["id","createdAt","updatedAt","deletedAt","retakePicture","isCanceled","isAnonymous","visitFlowTypeId"]},"visits-history_list":{"title":"visits-history list","type":"array","items":{"$ref":"#/components/schemas/visits-history"}},"hostsSituationEnable":{"type":"object","required":["hostIds"],"properties":{"hostIds":{"type":"array","items":{"type":"string","description":"Array of IDs from the hosts to be enabled"}}}},"hostsSituationDisable":{"type":"object","properties":{"email":{"type":"string","description":"Host email that will replace the current one in meetings"},"hostIds":{"type":"array","items":{"type":"string","description":"Array of IDs from the hosts to be enabled"}}}},"situation":{"title":"Host","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"name":{"type":"string"},"email":{"type":"string"},"role":{"type":"string","enum":["ADMIN","MANAGER","SECURITY","FRONTDESK","HOST","EMPLOYEE"],"default":"HOST"},"isActive":{"type":"boolean","default":true},"preCheckinNotifications":{"type":"boolean","default":true},"isPhoneValid":{"type":"boolean","default":false},"sendInvitationEmail":{"type":"boolean","default":false},"additionalEmails":{"type":"array","items":{"type":"string"},"nullable":true,"default":[]},"additionalPhones":{"type":"array","items":{"type":"string"},"nullable":true,"default":[]},"pictureUrl":{"type":"string","nullable":true},"pictureThumbUrl":{"type":"string","nullable":true},"position":{"type":"string","nullable":true},"cpf":{"type":"string","nullable":true},"sector":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"countryCode":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"deliveryNotification":{"type":"boolean","nullable":true,"default":false},"metadata":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"defaultMeetingLocationId":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true},"createdById":{"type":"string","nullable":true},"companyId":{"type":"string"},"defaultMeetingTypeId":{"type":"string","nullable":true},"zoneId":{"type":"string","nullable":true},"invenziId":{"type":"string","nullable":true},"mifareCardNumber":{"type":"array","items":{"type":"string"},"nullable":true},"allowCredentialing":{"type":"boolean","nullable":true,"default":false},"canAuthorizeAllCredentialing":{"type":"boolean","nullable":true,"default":false}},"required":["id","createdAt","updatedAt","deletedAt","name","email","role","isActive","preCheckinNotifications","isPhoneValid","sendInvitationEmail","additionalEmails","additionalPhones","deliveryNotification","companyId","allowCredentialing","canAuthorizeAllCredentialing"]},"situation_list":{"title":"situation list","type":"array","items":{"$ref":"#/components/schemas/situation"}},"visits-config":{"title":"Visits_config","type":"object","properties":{"id":{"type":"string","default":{}},"createdAt":{"type":"string","format":"date-time","default":{}},"updatedAt":{"type":"string","format":"date-time","default":{}},"deletedAt":{"type":"string","format":"date-time","nullable":true,"default":null},"preCheckinMinDetectionScore":{"type":"number","format":"float","nullable":true},"preCheckinTakePictureOnDetect":{"type":"boolean","nullable":true,"default":false},"touchlessMinDetectionScore":{"type":"number","format":"float","nullable":true},"touchlessTakePictureOnDetect":{"type":"boolean","nullable":true,"default":false},"kioskMinDetectionScore":{"type":"number","format":"float","nullable":true},"kioskTakePictureOnDetect":{"type":"boolean","nullable":true,"default":true},"companyId":{"type":"string","format":"uuid"},"secondsToTakePictureKiosk":{"type":"integer","format":"int32","nullable":true,"default":3},"secondsToTakePictureTouchless":{"type":"integer","format":"int32","nullable":true},"secondsToTakePicturePreCheckin":{"type":"integer","format":"int32","nullable":true},"showPhotoInstructionsKiosk":{"type":"boolean","nullable":true},"isFaceLivenessEnabled":{"type":"boolean","nullable":true},"requireMeetingForCheckin":{"type":"boolean","nullable":true},"ipadMeetingErrorMessage":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"ipadCheckinErrorMessage":{"anyOf":[{"type":"object"},{"type":"array"},{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}],"nullable":true},"disableFacialValidation":{"type":"boolean","nullable":true},"customBlocklistErrorMessage":{"type":"string","maxLength":255,"nullable":true}},"required":["id","createdAt","updatedAt","deletedAt","preCheckinTakePictureOnDetect","touchlessTakePictureOnDetect","kioskTakePictureOnDetect","companyId","secondsToTakePictureKiosk"]},"visits-config_list":{"title":"visits-config list","type":"array","items":{"$ref":"#/components/schemas/visits-config"}}}},"security":[{"companyApiSecret":[]}],"paths":{"/company/companies":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/companies"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/companies_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of companies","summary":"","tags":["Companies"],"security":[{"companyApiSecret":[]}]}},"/company/companies/{companyId}":{"get":{"parameters":[{"in":"path","name":"companyId","description":"ID of the company","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/companies"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a company by its id. Only a user from the specific company can get its information","summary":"","tags":["Companies"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"companyId","description":"ID of the company","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/companies"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a company","summary":"","tags":["Companies"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesUpdate"}}}}}},"/company/hosts":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/hosts"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosts_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of host","summary":"","tags":["Hosts"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosts"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a host","summary":"","tags":["Hosts"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostsAdd"}}}}}},"/company/hosts/{hostId}":{"get":{"parameters":[{"in":"path","name":"hostId","description":"ID of the host","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosts"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a host by its id.","summary":"","tags":["Hosts"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"hostId","description":"ID of the host","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosts"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a host","summary":"","tags":["Hosts"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"hostId","description":"ID of the host","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosts"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a host","summary":"","tags":["Hosts"],"security":[{"companyApiSecret":[]}]}},"/company/blocklists":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/blocklists"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/blocklists_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a lists of blocked visits","summary":"","tags":["Blocklists"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/blocklists"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a visitor to the blocklists","summary":"","tags":["Blocklists"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlocklistAdd"}}}}}},"/company/blocklists/{blocklistId}":{"get":{"parameters":[{"in":"path","name":"blocklistId","description":"ID of the blocked visitor from blocklist","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/blocklists"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a blocked visitor from blocklists by its id.","summary":"","tags":["Blocklists"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"blocklistId","description":"ID of the blocklist","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/blocklists"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a blocked visitor from the lists","summary":"","tags":["Blocklists"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlocklistUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"blocklistId","description":"ID of the blocklist","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/blocklists"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a blocklists","summary":"","tags":["Blocklists"],"security":[{"companyApiSecret":[]}]}},"/company/meetings":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/meetings"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meetings_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of meetings","summary":"","tags":["Meetings"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meetings"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a meeting","summary":"","tags":["Meetings"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meetingsAdd"}}}}}},"/company/meetings/{meetingId}":{"get":{"parameters":[{"in":"path","name":"meetingId","description":"ID of the meeting","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meetings"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a meeting by its id.","summary":"","tags":["Meetings"],"security":[{"companyApiSecret":[]}]}},"/company/meetings/{id}":{"patch":{"parameters":[{"in":"path","name":"id","description":"ID of the meeting","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meetings"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a meeting","summary":"","tags":["Meetings"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meetingsUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"id","description":"ID of the meeting","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meetings"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a meeting","summary":"","tags":["Meetings"],"security":[{"companyApiSecret":[]}]}},"/company/notifications":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/notifications"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notifications_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of notifications","summary":"","tags":["Notifications"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notifications"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a notification","summary":"","tags":["Notifications"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationsAdd"}}}}}},"/company/notifications/{notificationId}":{"get":{"parameters":[{"in":"path","name":"notificationId","description":"ID of the notification","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notifications"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a notification by its id.","summary":"","tags":["Notifications"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"notificationId","description":"ID of the notification","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notifications"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a notification","summary":"","tags":["Notifications"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationsUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"notificationId","description":"ID of the notification","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notifications"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a notification","summary":"","tags":["Notifications"],"security":[{"companyApiSecret":[]}]}},"/company/visits":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/visits"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of visits","summary":"","tags":["Visits"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a visit","summary":"","tags":["Visits"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/visitsAdd"}}}}}},"/company/visits/{visitId}":{"get":{"parameters":[{"in":"path","name":"visitId","description":"ID of the visit","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a visit by its id.","summary":"","tags":["Visits"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"visitId","description":"ID of the visit","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a visit","summary":"","tags":["Visits"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/visitsUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"visitId","description":"ID of the visit","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a visit","summary":"","tags":["Visits"],"security":[{"companyApiSecret":[]}]}},"/company/deliveries":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/deliveries"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deliveries_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of deliveries","summary":"","tags":["Deliveries"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deliveries"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a delivery","summary":"","tags":["Deliveries"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveriesAdd"}}}}}},"/company/deliveries/{deliveryId}":{"get":{"parameters":[{"in":"path","name":"deliveryId","description":"ID of the delivery","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deliveries"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a delivery by its id.","summary":"","tags":["Deliveries"],"security":[{"companyApiSecret":[]}]},"delete":{"parameters":[{"in":"path","name":"deliveryId","description":"ID of the delivery","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deliveries"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a delivery","summary":"","tags":["Deliveries"],"security":[{"companyApiSecret":[]}]}},"/company/webhooks":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/webhooks"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of webhooks","summary":"","tags":["Webhooks"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a webhook","summary":"","tags":["Webhooks"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooksAdd"}}}}}},"/company/webhooks/{webhookId}":{"get":{"parameters":[{"in":"path","name":"webhookId","description":"ID of the webhook","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a webhook by its id.","summary":"","tags":["Webhooks"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"webhookId","description":"ID of the webhook","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a webhook","summary":"","tags":["Webhooks"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooksUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"webhookId","description":"ID of the webhook","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a webhook","summary":"","tags":["Webhooks"],"security":[{"companyApiSecret":[]}]}},"/company/qrcodes":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/qrcodes"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/qrcodes_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a lists of qrcodes","summary":"","tags":["QRCodes"],"security":[{"companyApiSecret":[]}]}},"/company/qrcodes/{QRCodeId}":{"get":{"parameters":[{"in":"path","name":"QRCodeId","description":"ID of the qrcode was read by host","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/qrcodes"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a read qrcode by its id.","summary":"","tags":["QRCodes"],"security":[{"companyApiSecret":[]}]}},"/company/company-integrations":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/company-integrations"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/company-integrations_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of company integrations","summary":"","tags":["Company Integrations"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/company-integrations"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a company integration","summary":"","tags":["Company Integrations"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/companyIntegrationsAdd"}}}}}},"/company/company-integrations/{companyIntegrationId}":{"get":{"parameters":[{"in":"path","name":"companyIntegrationId","description":"ID of the company integration","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/company-integrations"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a company integration by its id.","summary":"","tags":["Company Integrations"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"companyIntegrationId","description":"ID of the company integration","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/company-integrations"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a company integration","summary":"","tags":["Company Integrations"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/companyIntegrationsUpdate"}}}}}},"/company/customizations":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/customizations"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customizations_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of customizations variables of different companies.","summary":"","tags":["Customizations"],"security":[{"companyApiSecret":[]}]}},"/company/customizations/{customizationId}":{"get":{"parameters":[{"in":"path","name":"customizationId","description":"ID of the customization","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customizations"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a customization variables by its id.","summary":"","tags":["Customizations"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"customizationId","description":"ID of the customization","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customizations"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a customization","summary":"","tags":["Customizations"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customizationUpdate"}}}}}},"/company/waccess-integrations":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/waccess-integrations"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/waccess-integrations_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of waccess integration","summary":"","tags":["WAccess"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/waccess-integrations"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a waccess integration","summary":"","tags":["WAccess"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waccessAdd"}}}}}},"/company/waccess-integrations/{waccessId}":{"get":{"parameters":[{"in":"path","name":"waccessId","description":"ID of the waccess integration","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/waccess-integrations"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a waccess integration by its id.","summary":"","tags":["WAccess"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"waccessId","description":"ID of the waccess integration","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/waccess-integrations"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a waccess integration","summary":"","tags":["WAccess"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waccessUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"waccessId","description":"ID of the waccess integration","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/waccess-integrations"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a waccess integration","summary":"","tags":["WAccess"],"security":[{"companyApiSecret":[]}]}},"/company/meeting-types":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/meeting-types"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of meeting types","summary":"","tags":["Meeting Types"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a meeting type","summary":"","tags":["Meeting Types"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meetingTypeAdd"}}}}}},"/company/meeting-types/{meetingTypeId}":{"get":{"parameters":[{"in":"path","name":"meetingTypeId","description":"ID of the meeting type","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a meeting type by its id.","summary":"","tags":["Meeting Types"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"meetingTypeId","description":"ID of the meeting type","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a meeting type","summary":"","tags":["Meeting Types"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meetingTypeUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"meetingTypeId","description":"ID of the meeting type","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a meeting type","summary":"","tags":["Meeting Types"],"security":[{"companyApiSecret":[]}]}},"/company/custom-fields":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/custom-fields"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-fields_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of custom fields","summary":"","tags":["Custom Fields"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-fields"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a custom field","summary":"","tags":["Custom Fields"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFieldAdd"}}}}}},"/company/custom-fields/{customFieldId}":{"get":{"parameters":[{"in":"path","name":"customFieldId","description":"ID of the custom field","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-fields"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a custom field by its id.","summary":"","tags":["Custom Fields"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"customFieldId","description":"ID of the custom field","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-fields"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a custom field","summary":"","tags":["Custom Fields"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFieldUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"customFieldId","description":"ID of the custom field","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-fields"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a custom field","summary":"","tags":["Custom Fields"],"security":[{"companyApiSecret":[]}]}},"/company/hosts-meeting-types":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/hosts-meeting-types"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosts-meeting-types_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of hosts meeting types","summary":"","tags":["Hosts Meeting Types"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosts-meeting-types"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a hosts meeting type","summary":"","tags":["Hosts Meeting Types"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostMeetingTypeAdd"}}}}},"delete":{"parameters":[{"description":"Host id to deleted it.","in":"query","name":"hostId","type":"string","required":true},{"description":"Meeting type id to delete it.","in":"query","name":"meetingTypeId","type":"string","required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosts-meeting-types_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a hosts meeting type","summary":"","tags":["Hosts Meeting Types"],"security":[{"companyApiSecret":[]}]}},"/company/meeting-types-custom-fields":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/meeting-types-custom-fields"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types-custom-fields_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of meeting type custom fields","summary":"","tags":["Meeting Types Custom Fields"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types-custom-fields"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a custom fields to a meeting type","summary":"","tags":["Meeting Types Custom Fields"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meetingTypeCustomFieldAdd"}}}}},"delete":{"parameters":[{"description":"Custom field id to be removed.","in":"query","name":"customFieldsId","type":"string","required":true},{"description":"Meeting type id to be removed.","in":"query","name":"meetingTypeId","type":"string","required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types-custom-fields_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to remove a custom field from a meeting type","summary":"","tags":["Meeting Types Custom Fields"],"security":[{"companyApiSecret":[]}]}},"/company/meeting-locations":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/meeting-locations"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-locations_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of meeting locations","summary":"","tags":["Meeting Locations"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-locations"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a meeting location","summary":"","tags":["Meeting Locations"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meetingLocationsAdd"}}}}}},"/company/meeting-locations/{meetingLocationId}":{"get":{"parameters":[{"in":"path","name":"meetingLocationId","description":"ID of the meeting location","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-locations"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a meeting location by its id.","summary":"","tags":["Meeting Locations"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"meetingLocationId","description":"ID of the meeting location","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-locations"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a meeting location","summary":"","tags":["Meeting Locations"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meetingLocationsUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"meetingLocationId","description":"ID of the meeting location","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-locations"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a meeting location","summary":"","tags":["Meeting Locations"],"security":[{"companyApiSecret":[]}]}},"/company/notification-hosts":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/notification-hosts"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification-hosts_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of notification host","summary":"","tags":["Notification hosts"],"security":[{"companyApiSecret":[]}]}},"/locale":{"post":{"parameters":[{"name":"companyId","in":"query","description":"ID of the company (optional)","schema":{"type":"string"}},{"name":"app","in":"query","description":"Name of the app (optional)","schema":{"type":"string","enum":["dashboard","totem","invites","app-host","server"]}}],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/locale"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint uploads the translation worksheet.\n      Note: To use this endpoint, you need to obtain a valid key from the team.","summary":"","tags":["Locale"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/locale"}}}}}},"/company/host-zones":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/host-zones"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/host-zones_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of host zones","summary":"","tags":["Host zones"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/host-zones"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a host zone","summary":"","tags":["Host zones"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostZoneAdd"}}}}},"delete":{"parameters":[{"description":"Host id to deleted it.","in":"query","name":"hostId","type":"string","required":true},{"description":"Zone id to delete it.","in":"query","name":"zoneId","type":"string","required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/host-zones_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a host zones","summary":"","tags":["Host zones"],"security":[{"companyApiSecret":[]}]}},"/company/zones":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/zones"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a lists of zones","summary":"","tags":["Zones"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a zone","summary":"","tags":["Zones"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zoneAdd"}}}}}},"/company/zones/{id}":{"get":{"parameters":[{"in":"path","name":"id","description":"ID of the zone","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a read zone by its id.","summary":"","tags":["Zones"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"id","description":"ID of the zone","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a zone","summary":"","tags":["Zones"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zoneUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"id","description":"ID of the zone","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a zone","summary":"","tags":["Zones"],"security":[{"companyApiSecret":[]}]}},"/company/meeting-types-zones":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/meeting-types-zones"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types-zones_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"Retrieves a list of all resources from the service.","summary":"","tags":["company"],"security":[]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types-zones"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"Creates a new resource with data.","summary":"","tags":["company"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types-zones"}}}}}},"/company/meeting-types-zones/{id}":{"get":{"parameters":[{"in":"path","name":"id","description":"ID of meeting-types-zones to return","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types-zones"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"Retrieves a single resource with the given id from the service.","summary":"","tags":["company"],"security":[]},"put":{"parameters":[{"in":"path","name":"id","description":"ID of meeting-types-zones to update","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types-zones"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"Updates the resource identified by id using data.","summary":"","tags":["company"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types-zones"}}}}},"patch":{"parameters":[{"in":"path","name":"id","description":"ID of meeting-types-zones to update","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types-zones"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"Updates the resource identified by id using data.","summary":"","tags":["company"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types-zones"}}}}},"delete":{"parameters":[{"in":"path","name":"id","description":"ID of meeting-types-zones to remove","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-types-zones"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"Removes the resource with id.","summary":"","tags":["company"],"security":[]}},"/company/children/visits":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/children"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/children_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of children companies visits","summary":"","tags":["Children Visits"],"security":[{"companyApiSecret":[]}]}},"/company/access-levels":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/access-levels"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/access-levels_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of access levels","summary":"","tags":["Access Levels"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/access-levels"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add an access level","summary":"","tags":["Access Levels"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/accessLevelAdd"}}}}}},"/company/access-levels/{accessLevelId}":{"get":{"parameters":[{"in":"path","name":"accessLevelId","description":"ID of the access level","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/access-levels"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get an access level by its id.","summary":"","tags":["Access Levels"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"accessLevelId","description":"ID of the access level","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/access-levels"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update an access level","summary":"","tags":["Access Levels"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/accessLevelUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"accessLevelId","description":"ID of the access level","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/access-levels"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete an access level","summary":"","tags":["Access Levels"],"security":[{"companyApiSecret":[]}]}},"/company/meeting-configs":{"get":{"parameters":[{"name":"meetingId","in":"query","required":true,"description":"ID of the meeting","schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-configs_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of meeting configs","summary":"","tags":["Meeting Configs"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-configs"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a meeting configs","summary":"","tags":["Meeting Configs"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meetingConfigsCreate"}}}}}},"/company/meeting-configs/{id}":{"patch":{"parameters":[{"in":"path","name":"id","description":"ID of the meeting configs","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-configs"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a meeting configs","summary":"","tags":["Meeting Configs"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/meetingConfigsUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"id","description":"ID of the meeting configs","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/meeting-configs"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a meeting configs","summary":"","tags":["Meeting Configs"],"security":[{"companyApiSecret":[]}]}},"/company/visit-flow-types":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/visit-flow-types"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visit-flow-types_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of visit flow types","summary":"","tags":["Visit Flow Types"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visit-flow-types"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a new visit flow type","summary":"","tags":["Visit Flow Types"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/visitFlowTypeAdd"}}}}}},"/company/visit-flow-types/{visitFlowTypeId}":{"get":{"parameters":[{"in":"path","name":"visitFlowTypeId","description":"ID of the visit flow type","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visit-flow-types"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a visit flow type by its ID.","summary":"","tags":["Visit Flow Types"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"visitFlowTypeId","description":"ID of the visit flow type","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visit-flow-types"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update an existing visit flow type","summary":"","tags":["Visit Flow Types"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/visitFlowTypeUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"visitFlowTypeId","description":"ID of the visit flow type","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visit-flow-types"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a visit flow type","summary":"","tags":["Visit Flow Types"],"security":[{"companyApiSecret":[]}]}},"/company/allowlists":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/allowlists"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/allowlists_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a lists of allowed visits","summary":"","tags":["Allowlists"],"security":[{"companyApiSecret":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/allowlists"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to add a visitor to the allowlists","summary":"","tags":["Allowlists"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/allowlistAdd"}}}}}},"/company/allowlists/{allowlistId}":{"get":{"parameters":[{"in":"path","name":"allowlistId","description":"ID of the allowed visitor from allowlist","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/allowlists"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a allowed visitor from allowlists by its id.","summary":"","tags":["Allowlists"],"security":[{"companyApiSecret":[]}]},"patch":{"parameters":[{"in":"path","name":"allowlistId","description":"ID of the allowlist","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/allowlists"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to update a allowed visitor from the lists","summary":"","tags":["Allowlists"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/allowlistUpdate"}}}}},"delete":{"parameters":[{"in":"path","name":"allowlistId","description":"ID of the allowlist","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/allowlists"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to delete a allowlists","summary":"","tags":["Allowlists"],"security":[{"companyApiSecret":[]}]}},"/company/visits-history":{"get":{"parameters":[{"name":"includeCustomFields","in":"query","description":"Include custom fields in the visit response","required":false,"type":"boolean","default":false},{"name":"includeFeedbacks","in":"query","description":"Include feedbacks in the visit response","required":false,"type":"boolean","default":false},{"name":"includeExtraHostFormFields","in":"query","description":"Include extra host form fields in the visit response","required":false,"type":"boolean","default":false},{"name":"includeMeetingVisitFields","in":"query","description":"Include meeting visit fields in the visit response","required":false,"type":"boolean","default":false},{"name":"includeQuestionnaireFields","in":"query","description":"Include questionnaire fields in the visit response","required":false,"type":"boolean","default":false},{"name":"includeHost","in":"query","description":"Include host information in the visit response","required":false,"type":"boolean","default":false},{"name":"includeMeeting","in":"query","description":"Include meeting information in the visit response","required":false,"type":"boolean","default":false},{"name":"includeMeetingDetails","in":"query","description":"Include meeting details in the visit response","required":false,"type":"boolean","default":false},{"name":"includeAuthorizedBy","in":"query","description":"Include authorized by details in the visit response","required":false,"type":"boolean","default":false},{"name":"includeCheckinByIpad","in":"query","description":"Include check-in by iPad details in the visit response","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits-history_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of history visits","summary":"","tags":["VisitsHistory"],"security":[{"companyApiSecret":[]}]}},"/company/visits-history/{visitId}":{"get":{"parameters":[{"name":"visitId","in":"path","description":"ID of the visit","required":true,"type":"string"},{"name":"includeCustomFields","in":"query","description":"Include custom fields in the visit response","required":false,"type":"boolean","default":false},{"name":"includeFeedbacks","in":"query","description":"Include feedbacks in the visit response","required":false,"type":"boolean","default":false},{"name":"includeExtraHostFormFields","in":"query","description":"Include extra host form fields in the visit response","required":false,"type":"boolean","default":false},{"name":"includeMeetingVisitFields","in":"query","description":"Include meeting visit fields in the visit response","required":false,"type":"boolean","default":false},{"name":"includeQuestionnaireFields","in":"query","description":"Include questionnaire fields in the visit response","required":false,"type":"boolean","default":false},{"name":"includeHost","in":"query","description":"Include host information in the visit response","required":false,"type":"boolean","default":false},{"name":"includeMeeting","in":"query","description":"Include meeting information in the visit response","required":false,"type":"boolean","default":false},{"name":"includeMeetingDetails","in":"query","description":"Include meeting details in the visit response","required":false,"type":"boolean","default":false},{"name":"includeAuthorizedBy","in":"query","description":"Include authorized by details in the visit response","required":false,"type":"boolean","default":false},{"name":"includeCheckinByIpad","in":"query","description":"Include check-in by iPad details in the visit response","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits-history"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a visit by its id.","summary":"","tags":["VisitsHistory"],"security":[{"companyApiSecret":[]}]}},"/company/children/visits-history":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/children"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/children_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to get a list of children companies visits","summary":"","tags":["Children Visits"],"security":[{"companyApiSecret":[]}]}},"/company/situation/hosts":{"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/situation"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"This endpoint allows you to enable hosts","summary":"","tags":["Hosts"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostsSituationEnable"}}}}}},"/company/situation/hosts/{hostId}":{"patch":{"parameters":[{"name":"hostId","in":"path","equired":false,"description":"ID of the host to be disabled","schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/situation"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"This endpoint allows you to disable hosts","summary":"","tags":["Hosts"],"security":[{"companyApiSecret":[]}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostsSituationDisable"}}}}}},"/company/visits-config":{"get":{"parameters":[{"description":"Number of results to return","in":"query","name":"$limit","schema":{"type":"integer"}},{"description":"Number of results to skip","in":"query","name":"$skip","schema":{"type":"integer"}},{"description":"Property to sort results","in":"query","name":"$sort","style":"deepObject","schema":{"type":"object"}},{"description":"Query parameters to filter","in":"query","name":"filter","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/visits-config"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits-config_list"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"Retrieves a list of all resources from the service.","summary":"","tags":["company"],"security":[]},"post":{"parameters":[],"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits-config"}}}},"401":{"description":"not authenticated"},"500":{"description":"general error"}},"description":"Creates a new resource with data.","summary":"","tags":["company"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits-config"}}}}}},"/company/visits-config/{id}":{"get":{"parameters":[{"in":"path","name":"id","description":"ID of visits-config to return","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits-config"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"Retrieves a single resource with the given id from the service.","summary":"","tags":["company"],"security":[]},"put":{"parameters":[{"in":"path","name":"id","description":"ID of visits-config to update","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits-config"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"Updates the resource identified by id using data.","summary":"","tags":["company"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits-config"}}}}},"patch":{"parameters":[{"in":"path","name":"id","description":"ID of visits-config to update","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits-config"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"Updates the resource identified by id using data.","summary":"","tags":["company"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits-config"}}}}},"delete":{"parameters":[{"in":"path","name":"id","description":"ID of visits-config to remove","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/visits-config"}}}},"401":{"description":"not authenticated"},"404":{"description":"not found"},"500":{"description":"general error"}},"description":"Removes the resource with id.","summary":"","tags":["company"],"security":[]}}},"openapi":"3.0.2","tags":[{"name":"company","description":"A company service"}]}