help.search
Search the elron club Help Center
Search approved general DE/EN guidance for applicants, residents and coworking guests. Returns article IDs and canonical links. For emergency guidance and schedule-based office-hours status, call help.get with articleId after-hours-emergencies. Use rentals tools for current apartment availability and prices; personal tenancy details require the resident's own portal.
Parameterslimitquerylocaleoffsetcategory
help.get
Read an elron club help article
Read the same approved localized article as the public website, including related answers and next steps. after-hours-emergencies also returns schedule-based office-hours status in Europe/Zurich, the observation time, the published schedule and Swiss emergency numbers. A message does not guarantee immediate attendance. Historical examples never override an individual signed agreement. Returns no apartment credentials, staff notes or individual case data.
ParameterslocalearticleIdrequired
information.get
Read public elron club information
Read the current English or German company, corporate-housing, contact or legal information. Legal documents are information, not acceptance of terms. Personal tenancy facts require the resident portal.
Parameterstopicrequiredlocale
locations.search
Find public apartment locations
Find published apartment buildings by city, region or name. Returns public locationId slugs for locations.get; no private property identifiers are returned.
Parameterslimitquerylocaleoffset
locations.get
Read a public apartment location
Read published building and neighborhood information, media and apartment slugs using locationId from locations.search. Published rental details and pricing remain available through rentals.get.
ParameterslocalelocationIdrequired
regions.list
Explore elron club regions
Read the published Swiss regions, local facts and canonical region pages. Use rentals.search for current inventory and availability.
Parameterslocale
jobs.search
Find public job openings
Search the published elron club job openings. Returns jobId slugs for jobs.get; recruitment follows the published email application handoff.
Parametersquerylocale
jobs.get
Read a public job opening
Read one published role and its email application instructions using jobId from jobs.search. This does not send an application or make a hiring decision.
ParametersjobIdrequiredlocale
contact.submit
Send a public contact request
Send a customer-confirmed apartment inquiry, corporate housing request, resident support report, or general question through the same website intake. Resident support accepts only photo upload tokens from contact.upload_photo; it grants no access to tenancy records. May send the existing receipt email. Preserve one idempotencyKey when retrying.
ParametersnamerequiredemailrequiredphonelocalemessagerequiredcategoryrequiredconfirmedrequiredcompanyNameapartmentCountidempotencyKeyrequireddesiredMoveInDatephotoUploadTokens+1 more
contact.upload_photo
Upload a public support photo
Upload one customer-approved JPEG or PNG support photo, up to 5 MiB, as base64. The shared image sanitizer strips metadata and returns a single-use 30-minute upload token for contact.submit. Arbitrary URLs and storage keys are not accepted. Keep the idempotencyKey stable for retries.
ParametersfileNamerequiredmimeTyperequiredconfirmedrequiredcontentBase64requiredidempotencyKeyrequired
applications.get
Read your verified request draft
Read the customer-editable fields and current version of the email-verified request session. This result contains the session owner's personal information and must remain within that customer's context. Unverified, expired and revoked sessions are refused.
ParameterssessionTokenrequired
applications.list_documents
List your verified request documents
List document metadata owned by the email-verified request session. Use documentId with applications.get_document or applications.remove_document. Returns no storage keys or employee data.
ParameterssessionTokenrequired
applications.get_document
Open your verified request document
Return an authenticated binary-download URL for one document owned by the email-verified session. The link contains a scoped credential: do not share or log it. Use documentId from applications.list_documents.
ParametersdocumentIdrequiredsessionTokenrequired
applications.remove_document
Remove your draft request document
Remove one explicitly selected document from an editable, email-verified request draft, using documentId from applications.list_documents and the current version. Submitted requests remain locked; exact retries replay the receipt.
ParametersconfirmedrequireddocumentIdrequiredsessionTokenrequiredidempotencyKeyrequiredexpectedVersionrequired
inquiries.activate
Send your viewing inquiry
Activate the email-verified draft as a viewing inquiry, using its current version and explicit customer confirmation. Existing inquiries are reused. Submitted requests cannot switch back to an inquiry.
ParametersconfirmedrequiredsessionTokenrequiredidempotencyKeyrequiredexpectedVersionrequired
applications.withdraw
Withdraw your viewing inquiry
Record the customer's explicit loss of interest in the owning inquiry and cancel its arrangements through the same website workflow. Once a Request owns the journey, contact the team instead; this tool cannot cancel a contract or tenancy.
ParametersnoteconfirmedrequiredsessionTokenrequiredidempotencyKeyrequiredexpectedVersionrequired
viewings.cancel
Cancel a viewing or your proposed time
Cancel a future confirmed appointment or withdraw the customer's own pending proposal. Use appointmentId or proposalId from viewings.get_details, current request version, and explicit confirmation. This may send the existing cancellation communication.
ParametersnotetargetrequiredtargetIdrequiredconfirmedrequiredsessionTokenrequiredidempotencyKeyrequiredexpectedVersionrequired
viewings.get_details
Read your viewing arrangements
Read session-owned proposals, availability windows, appointments, and post-viewing feedback versions. Includes only customer-facing information and viewing instructions currently released to this customer by the canonical owner; internal notes and unreleased or revoked contact details are excluded.
ParameterssessionTokenrequired
viewings.request_contact
Request viewing contact instructions
Ask elron club to arrange the resident contact for one SHARE_TENANT_CONTACT arrangement returned by viewings.get_details. Requires an owning verified inquiry, exact version and explicit customer confirmation. This never releases contact data or changes resident permission; read get_details later for instructions actually released by the team.
ParametersconfirmedrequiredsessionTokenrequiredarrangementIdrequiredidempotencyKeyrequiredexpectedVersionrequired
viewings.respond_after_viewing
Record your decision after a viewing
Record PROCEED, NOT_INTERESTED, NEEDS_ALTERNATIVES or ANOTHER_VIEWING for one elapsed appointment from viewings.get_details. Requires the current request version, exact feedbackVersion and explicit customer confirmation. Proceeding does not submit a Request or create a booking.
ParametersnoteresponserequiredconfirmedrequiredsessionTokenrequiredappointmentIdrequiredidempotencyKeyrequiredexpectedVersionrequiredfeedbackVersionrequired
viewings.proceed_without_viewing
Continue without a viewing
Record the customer's explicit decision to continue the rental journey without a viewing. Uses the verified session, exact version and stable idempotency key; all separate Request approval and legal gates remain in force.
ParametersconfirmedrequiredsessionTokenrequiredidempotencyKeyrequiredexpectedVersionrequired
applications.select_rental
Choose an apartment for your inquiry
Select a published apartment by rentalId from rentals.search within the customer's verified, editable inquiry context. Existing selection and stage rules are enforced by the website service; submitted requests cannot change apartments.
ParametersrentalIdrequiredconfirmedrequiredsessionTokenrequiredidempotencyKeyrequiredexpectedVersionrequired
applications.set_consents
Record your request consent choices
Record the verified customer's explicit privacy, credit-check and truth-confirmation choices on an editable draft. Each boolean is the customer's actual choice; this does not submit a Request or sign a contract.
ParametersconfirmedrequiredsessionTokenrequiredtruthAcceptedrequiredcreditAcceptedrequiredidempotencyKeyrequiredexpectedVersionrequiredprivacyAcceptedrequired
viewings.set_availability
Share viewing availability windows
Add one to five future availability windows to the verified inquiry. Times are ISO 8601 with timezone offsets; endAt must follow startAt. This does not confirm an appointment.
ParameterswindowsrequiredconfirmedrequiredsessionTokenrequiredidempotencyKeyrequiredexpectedVersionrequired
portal.request_access
Recover your resident portal access
Request the existing secure resident-portal access email for the customer's own address. Always returns the same generic acknowledgement, without disclosing tenancy existence, identity, access codes or links. Identity verification and personal tenant actions remain in the private resident portal.
ParametersemailrequiredlocaleconfirmedrequiredidempotencyKeyrequired
viewings.decline_proposals
Decline selected viewing proposals
Decline one or more exact pending elron club proposals from viewings.get_details in one version-bound, customer-confirmed operation. Only the selected proposals are changed; later offers are preserved.
ParametersconfirmedrequiredproposalIdsrequiredsessionTokenrequiredidempotencyKeyrequiredexpectedVersionrequired
waitlist.confirm
Confirm an existing newsletter email invitation
Confirm an older newsletter invitation only with its separate confirmation token and the customer's explicit consent. Current availability signup activates immediately; this tool never manufactures a confirmation token.
ParameterstokenrequiredconfirmedrequiredidempotencyKeyrequired
waitlist.preferences.get
Read regions for availability updates
Use the opaque Manage regions token from an update email to read the selected regions and current version. Returns no internal contact or building identifiers.
Parameterstokenrequired
waitlist.preferences.update
Change regions for availability updates
Add or remove one exact region, or unsubscribe from all updates, using an opaque Manage regions token, the version from waitlist.preferences.get and a stable UUID idempotency key. Adding a region requires explicit customer consent. Stale state fails unchanged; an uncertain result must be reconciled before another attempt.
ParameterstokenrequiredactionrequiredconsentregionKeyidempotencyKeyrequiredexpectedVersionrequired
waitlist.subscribe
Subscribe to availability updates
Activate availability updates immediately after explicit customer consent for one or more of Basel, Bern, Luzern or Zürich. An exact public rentalId can select its canonical region; no apartment or building list is created. A new activation queues one welcome email; repeated signup does not repeat it. Only explicit customer action can restore the requested opted-out region. Signup creates no reservation or priority.
ParametersemailrequiredlocaleconsentrequiredrentalIdregionKeyregionKeysidempotencyKeyconsentCopyVersion
waitlist.unsubscribe
Unsubscribe from all apartment updates
Use an opaque unsubscribe token from an elron club update email to stop all availability updates.
ParameterstokenrequiredidempotencyKey
rentals.search
Search published Elron Club rentals
Return a compact, actionable shortlist of published furnished apartments by location, availability, capacity, rooms, duration, and monthly rent. Defaults to 10 available or upcoming rentals; call rentals.get for complete details.
ParameterscitylimitquerylocaleregionminimumRoomsavailableFromdurationMonthsminimumOccupancyavailabilityStatusmaximumMonthlyRent
rentals.get
Get a published Elron Club rental
Return localized customer-safe apartment details, verified availability, duration pricing, deposit, included services, terms, eligibility, media, and inquiry/application links.
ParameterslocalerentalIdrequired
rentals.check_availability
Check verified rental availability
Check the current published availability state and earliest date for one rental. This does not create a hold or reservation.
ParameterslocalerentalIdrequired
rentals.get_pricing
Get duration pricing and fees
Return current published monthly pricing by supported duration, parking, deposit, inclusions, payment method, and minimum-stay terms. Pricing is informational until a quote or hold is issued.
ParameterslocalerentalIdrequired
applications.start
Start an Elron Club inquiry or application
Create or reuse a duplicate-safe applicant workspace for one published rental. Requires explicit current privacy consent and an idempotency key. Email verification is sent to the applicant; the tool never returns the verification URL.
ParametersemailrequiredphonerequiredlocalejourneyrequiredlastNamerequiredrentalIdrequiredfirstNamerequiredidempotencyKeyrequireddesiredDurationMonthsprivacyConsentVersionrequiredrequestedParkingCountprivacyConsentAcceptedrequired
applications.get_status
Get public application status
Read the privacy-minimized status and next actions for one scoped application session token.
ParameterssessionTokenrequired
applications.update
Update a verified Elron Club application
Update bounded applicant, tenancy, billing and manual insurance-offer selection for one email-verified session using its exact current version and a durable idempotency key. Insurance choice is optional, never preselected or active cover; referral permission must be explicit. A household edit without a new insuranceSelection clears existing sharing permission and retains the package choice.
ParametersphonelastNamefirstNameadultCountminorCountpetSummarybillingCitycurrentCitybillingEmailsessionTokenrequiredidempotencyKeyrequiredtenantProfiles+33 more
applications.create_document_upload
Create a signed application-document upload
Create a 15-minute, exact-size and exact-content-type signed upload form for one email-verified application at its exact current version.
ParametersfileNamerequiredmimeTyperequiredsizeBytesrequiredcontextKeyrequiredsessionTokenrequiredidempotencyKeyrequiredexpectedVersionrequired
applications.complete_document_upload
Complete a signed application-document upload
Verify the uploaded object, content signature, session ownership, expiry, and exact application version before creating the protected document record.
ParameterssessionTokenrequiredidempotencyKeyrequiredexpectedVersionrequireduploadSessionIdrequired
applications.upload_document
Upload a verified application document
Upload one bounded PDF, JPEG, or PNG identity or company-registry document to an email-verified application using its exact version and a durable idempotency key.
ParametersfileNamerequiredmimeTyperequiredsizeBytesrequiredcontextKeyrequiredsessionTokenrequiredcontentBase64requiredidempotencyKeyrequiredexpectedVersionrequired
applications.submit
Submit a verified Elron Club application
Submit one complete email-verified application for review using its exact version, explicit current credit-check and truth-confirmation consent, and a durable idempotency key.
ParameterssessionTokenrequiredconsentVersionrequiredidempotencyKeyrequiredexpectedVersionrequiredtruthConfirmationAcceptedrequiredcreditCheckConsentAcceptedrequired
viewings.get_status
Get scoped viewing coordination status
Read customer-safe viewing proposals and confirmed viewing state for one email-verified application session.
ParameterssessionTokenrequired
viewings.propose_availability
Propose viewing availability
Propose one to five bounded future viewing slots from an email-verified application at its exact version using a durable idempotency key.
ParametersslotsrequiredsessionTokenrequiredidempotencyKeyrequiredexpectedVersionrequiredreplaceProposalIds
viewings.respond_to_proposal
Accept or decline a viewing proposal
Accept or decline one pending Elron Club proposal with explicit confirmation, an exact application version, and a durable idempotency key. Acceptance may send the existing viewing confirmation communication.
ParametersactionrequiredproposalIdrequiredsessionTokenrequiredidempotencyKeyrequiredexpectedVersionrequiredresponseConfirmedrequired
quotes.create
Create an approved Elron Club rental quote
Snapshot customer-safe approved request terms into a 24-hour quote. The application must be submitted, internally approved, due-diligence positive, and solvency passed. This does not hold inventory.
ParameterssessionTokenrequiredidempotencyKeyrequiredexpectedApplicationVersionrequired
quotes.get
Get a scoped Elron Club rental quote
Read one privacy-minimized quote and its live expiry/availability-hold state using the application session that owns it.
ParametersquoteIdrequiredsessionTokenrequired
quotes.accept
Accept a quote and claim an expiry-bound availability hold
With explicit customer confirmation, accept one exact active quote and atomically claim a 30-minute request-owned availability hold. This does not create or sign a contract and does not authorize payment.
ParametersquoteIdrequiredsessionTokenrequiredidempotencyKeyrequiredacceptanceConfirmedrequiredexpectedQuoteVersionrequired
reservations.get_status
Get scoped reservation progression status
Read privacy-minimized hold, contract, signature, payment, reservation, or confirmation state for one application session.
ParameterssessionTokenrequired
contracts.get_signing_link
Get the verified applicant's contract signing link
Return a secure signing URL only when the active signer invitation email matches the email-verified application session. Human verification, review, and signature remain in the signing flow.
ParameterssessionTokenrequired
payments.get_status
Get first-payment status
Return due and received payment truth for the scoped application. An approved human-action URL is returned only from an exact, unexpired provider session; no authorization URL is fabricated.
ParameterssessionTokenrequired
bookings.get_confirmation
Get booking confirmation
Return a privacy-minimized booking confirmation only after the request has converted into the authoritative Stay workflow.
ParameterssessionTokenrequired