start_signup
Start a company (no account yet)
Creates the company in Guest Logic (a hotel in free test mode) and e-mails the owner one approval link. Use only when the owner has no Guest Logic account. The reply names everything still missing and the tool that fills each. No sign-in needed.
Parameterskindrequiredemailrequiredtoolsrequiredmobilewebsitetime_zonelegal_nameowner_namerequiredbusiness_namerequired
The hotel's details: name, address, phone, rooms, check-in and check-out, taxes, and whether it is in test mode. Needs the owner's sign-in.
Takes no parameters.
setup_status
Setup checklist
Every fact this company needs, each Done, Missing, Needs us or Optional, with the tool that fills each missing one. Needs the owner's sign-in.
Takes no parameters.
set_company
Set the company details
The legal name, mailing address, billing e-mail, website and time zone. Send only what you have. Needs the owner's sign-in.
Parametersaddresswebsitetime_zonelegal_namebilling_email
set_venue
Set the event spaces
The event spaces and how many each holds, shown on quotes and the inquiry form. Replaces the list. Needs the owner's sign-in.
Parametersnotesspaces
set_hiring
Set the hiring details
The positions hired for (shown on the company's careers page), the hiring e-mail and the hiring phone. Needs the owner's sign-in.
Parameterspositionshiring_emailhiring_phone
E-mails a sign-in to each team member, up to 25 a call. Reports the result per person. Needs the owner's sign-in.
Parametersmembersrequired
For a PDF, picture or spreadsheet (up to 25 MB). Call with filename, content_type and size: you get an address to PUT the file to. After the PUT, call again with document_id: Guest Logic reads it and returns what was found. Types: PDF, PNG, JPEG, WebP, XLSX, XLS, CSV, TXT. Needs the owner's sign-in.
Parameterssizefilenamedocument_idcontent_type
request_go_live
Ask to go live
Files the request to go live once the legal name, address, billing e-mail and the owner's accepted agreement are in; otherwise names what is missing. The Guest Logic team presses the last button. Needs the owner's sign-in.
Takes no parameters.
upload_report
Upload a report
Sends one report's content as text (CSV, tab-separated or plain text, up to 4 MB) — read a PDF or spreadsheet first and send its rows. Guest Logic reads it and sets up what it can (rooms, room types, rates, taxes, stays). Returns what was found. Needs the owner's sign-in.
Parameterscontentrequiredfilenamerequired
submit_facts
Send rooms or stays you already read
Rooms and stays you already extracted, as rows. Guest Logic applies them by the same rules as an uploaded report. Needs the owner's sign-in.
Parametersroomsstays
confirm_facts
Confirm or change a step
Confirms or changes one setup step. step and values: hotel {name, phone, email} · taxes {state, tourism, other} as percentages · checkin {check_in, check_out} as HH:MM · policies {cancellation, deposit, noshow, pets, smoking} · room_types {CODE: {name, sleeps}} · rates {CODE: nightly rate} · rooms (confirm the room list) · ooo (no out-of-order rooms) · people (just the owner for now) · bookings (no bookings on hand). Needs the owner's sign-in.
Parameterssteprequiredvalues
Loads the stays read from the reports into the hotel. First call without confirm to see the rows that need a decision; show them to the owner; then call with confirm true. Needs the owner's sign-in.
Parametersconfirm
Adds a picture from a public web address (PNG, JPEG or WebP, up to 10 MB) to the booking page: the hotel, or one room type. 40 a day while testing. Needs the owner's sign-in.
Parametersurlrequiredcovercaptionroom_type
Sets the company's logo from a public web address (PNG, JPEG or WebP, up to 10 MB). Needs the owner's sign-in.
Parametersurlrequired
drop_link
Links to upload files by hand
The owner's links to drop files you cannot send as text (a scanned PDF) and to manage photos. Needs the owner's sign-in.
Takes no parameters.
ask_us
Ask Guest Logic to connect something
Asks the Guest Logic team to connect card payments, Expedia and Booking.com, or to finish the whole setup by hand. Connected within 24 hours. Needs the owner's sign-in.
Parametersnotewhatrequired
invite_staff
Invite a staff member
E-mails a sign-in to an employee or a manager. Needs the owner's sign-in.
Parametersroleemailrequiredfull_namerequired
stays
Stays in a date range
Stays touching a date range (up to 31 days): confirmation, guest, dates, room, type, status, rate, source. Up to 200 rows a call; use page for more. Needs the owner's sign-in.
Parameterstorequiredfromrequiredpagestatus
One stay by its confirmation number. Needs the owner's sign-in.
Parametersconfirmationrequired
availability
Rooms free each night
Rooms free each night by room type for a date range (up to 31 days). Needs the owner's sign-in.
Parameterstorequiredfromrequired
house_inventory
The house on one day
For one day: arrivals, departures, in house, rooms by housekeeping status, rooms out of order. Needs the owner's sign-in.
Parametersdate
list_automations
Automations
The company's automations: what each sends, when, and whether it is on. Needs the owner's sign-in.
Takes no parameters.
automation_status
Recent automation runs
The last runs of the company's automations: when, result, error. Needs the owner's sign-in.
Takes no parameters.
tasks_waiting_on_me
Tasks waiting on me
Open tasks on the signed-in person's Home board. Needs the owner's sign-in.
Takes no parameters.