Jump to Content
Home
Guides
API Reference
Changelog
Log In
API Reference
Log In
API Reference
Add a new location to a tenant.
JUMP TO
Cleanetto API
Agreement
Gets the list of agreements of the logged tenant.
get
Adds a new agreement to the logged tenant.
post
Gets an agreement by Id.
get
Updates an existing agreement.
put
Deletes an existing agreement.
del
Get an agreement to sign.
get
Gets an entity that might be involved in an agreement by user id.
get
Gets the data related to the booking the cleaner is assigned in agreements triggered OnCleanerAssign. The id required is for the ClientCleanerRequest entity which has specific data like start hour.
get
Auth
The Login returns a JWT bearer token for a valid username/password
post
/auth/sendresetlink
post
/auth/reset
post
/auth/checkcode
post
/auth/refresh-token
post
Booking
Get all events for the given booking id.
get
Get all cleaners assigned to the booking given by its Id.
get
Chat
/chat/conversations/{id}
get
/chat/token/{identity}
post
/chat/userchannels
get
/chat/getMembers/{identity}
get
/chat/getmessages/{channelId}
get
Sends a message to the current Conversation Service.
post
Deprecated endpoint. Used to send a message. Will be removed when all the apps migrate to: [Post] chat/message.
post
/chat/sendnotification
post
/chat/fixchannels
get
/chat/consumptionreport
post
/chat/migrate/{tenantUserId}
post
ChurnReason
/cleaner-churn-reasons
get
/client-churn-reasons
get
Cleaner
/cleaner/add
post
/cleaner/addDetailed
post
/cleaner/addEventException/{cleanHomeEventId}/{exceptionReasonId}
get
/cleaner/resolveEventException/{exceptionEventId}/{isResolved}
get
/cleaner/bossOfApplicantRate
post
/cleaner/getBossOfApplicantRate/{requestId}
get
/cleaner/getCleanerIdFromUserId/{userId}
get
/cleaner/getCleanerById/{id}
get
/cleaner/get/{id}
get
/cleaner/get-by-cleaner-id/{cleanerId}
get
/cleaner/delete/{id}
get
/cleaner/GetCleanerProfile
get
/cleaner/GetCleanerProfileById/{id}
get
/cleaner/GetCleanerImage/{id}
get
Get all the events the logged in cleaner is involved with, sorted asc by appointment date.
get
Get cleaner earnings for a given time period.
get
/cleaner/addContractDetails
post
/cleaner/update
post
/cleaner/changeCleanerStatus/{cleanerId}/{statusId}
get
/cleaner/changeSendNewJobNoty
put
/cleaner/updateCleanerLabel/{cleanerId}/{actionId}/{isActive}
get
Updates rate for a given cleaner.
patch
Get a list of jobs with no cleaner
get
Get location list for a given cleaner.
get
Add cleaner to a tenant location.
post
Removes a cleaner from a location.
del
Get cleaner unavailable hours. The values returned represent what hours under a week day the cleaner is unavailable.
get
Update cleaner unavailable hours.
put
Get cleaner's exception availability list.
get
Creates a new cleaner exception availability.
post
Updates a cleaner exception availability.
put
Deletes a cleaner availability exception.
del
Gets the cleaner net availability which checks for Gross Availability + Exception Availability and conflicts with already booked events.
get
Gets cleaners net availability which checks for Gross Availability + Exception Availability and conflicts with already booked events given a list of restriction set from a request (which implicitly has the cleaners Id).
post
Gets cleaner net availability which checks for Gross Availability + Exception Availability and conflicts with already booked events given a restriction set from a request (which implicitly has the cleaner Id).
post
/cleaner/allow-extra-time-notification/{userId}
get
/cleaner/update-device-token
post
/cleaner/allow-extra-time/{extraTime}/{userId}
get
/cleaner/accept-job-request/{cleanHomeRequestId}/{cleanerId}/{startTime}
get
/cleaner/send-push-notification/{userId}/{title}/{body}
get
Calculate the traveling time of the cleaner to the cleaning location and says if the cleaner is late or not.
get
Updates the start time of an event
put
Client
Get Client by id.
get
Gets the client list for the authenticated tenant as a paginated list.
get
Udpates a client.
put
Udpates a client.
patch
Return how many book once request a client has.
get
Get a list of locations by client
get
Get a list of tasks by client
get
Get a list of task instances for the current client.
get
Get a list of task instances for the given client.
get
Get a list of cleaners by client
get
/client/addHoursFromCancelledToNextEvent/{clientId}/{cancelledEventId}
get
/client/addCreditToStripeInvoice/{clientId}/{cancelledEventId}
get
/client/delete/{id}
del
Udpates a client.
patch
/client/add
post
/client/get-minutes-between-customers/{newClientId}/{existingClientId}/{mode}
get
/client/addclientbooking
post
/client/checkPromoCode/{promoCode}/{tenantUserId}
get
Get all events for the current client, sorted Asc by Appointment. Can filter by statusId, and for dates greater than appointmentDate.
get
Gets booking info related to current client.
get
Updates Credit Card data.
patch
/client/update-device-token
post
/client/send-push-notification/{userId}/{title}/{body}
get
/client/allow-extra-time-notification/{userId}
get
/client/cleaner-rating
post
/client/cleaner-rating-from-email
post
/client/cleaner-profile
get
Skip N events for a given client.
post
Pauses Cleaning subscription for a given Client.
post
Get images of events associated to a given client
get
Get Client by id without authentication.
get
Get the bookings with its assigned cleaners of a client, given the client's id.
get
Comments
/comment/add
post
/comment/getByUserId/{id}
get
Contract
/contract/sendViaEmail/{tenantId}/{cleanerId}
get
DashboardMetrics
/dashboard/metrics
get
/dashboard/getclientssupportchartdata
get
/dashboard/getcleanersupportchartdata
get
/dashboard/geteventssupportchartdata
get
/dashboard/getratingsdata
get
/dashboard/getcostandhoursdata
get
Event
/event/update-events-manually
get
/event/test
get
/event/cancelSubscription
post
/event/cancelSubscription/feedback
post
/event/cancelSubscription/{id}
post
/event/cancelSubscription/feedback/{id}
post
Generates events for a particular Event request.
get
Pauses Cleaning subscription for the current user.
post
Pauses Cleaning subscription by the client user id.
post
Resumes Cleaning subscription.
post
/event/cancelByCleaner
post
Skip N events for the authenticate client.
post
Skip selected events for the chosen client by id.
post
/event/add
post
/event/update
post
/event/status
put
Get all events. Can filter by clientId and/or statusId.
get
Get all events of cleaners. Can filter by date and cleaner.
post
Get event by eventId.
get
Delete an event.
post
/event/statuses
get
/event/time-preferences
get
/event/get-unhandled-event/{requestId}/{clientId}
get
Gets the real time in and out for an event instance.
get
Associates an image to an event, given the event id.
post
/event/oscar
get
ImportData
/importdata
post
Import a list of zip codes under a tenant location given a location name, the tenant id and the list of zip codes. If the location doesn't exist then it will create a new one with the given name.
post
/importdata/template
get
LeadSource
/cleaner-lead-sources
get
/client-lead-sources
get
Location
Get all locations.
get
Updates a Location.
put
Creates a location.
post
Partially updates a Location.
patch
Gets a location by Id.
get
Deletes a Location.
del
ManualAssignment
/manual-assignment/get-clean-home-request/{requestId}
get
/manual-assignment/get-cleaner-list
get
Get all cleaners for a tenant available in a location that a given zip code belongs to.
get
Gets the events for a list of cleaners filtered by a date.
post
/manual-assignment/get-conflicts
post
/manual-assignment/team/get-conflicts
post
/manual-assignment/assign-cleaner-to-clean-request/{cleanerId}/{requestId}/{hour}
get
/manual-assignment/assign-cleaner-to-clean-request/team
post
/manual-assignment/update-event-time/{id}/{hour}
get
/manual-assignment/update-future-events-time/{id}/{hour}
get
Notes
/note/add
post
/note/getCleanerNotes/{id}/{isUserId}
get
/note/getClientNotes/{id}/{isUserId}
get
Reports
/reports/clients-acquisition
get
/reports/clients-churn
get
/reports/cleaner-acquisition
get
/reports/cleaner-churn
get
/reports/satisfaction-report
get
Room
/room/add
post
/room/update
post
/room/delete/{id}
del
/room/getall
get
/room/get/{id}
get
/room/getallbasic
get
SignedAgreement
Gets the list of signed agreements for the logged tenant.
get
/signed-agreement
post
Gets a signed agreement by its Id.
get
Deletes an existing signed agreement.
del
Statistics
/statistics/getclientsstatistics
get
/statistics/GetCleanersStatistics
get
/statistics/GetEventsStatistics
get
StripeWebhook
/stripe/invoice-created
post
/stripe/invoice-created-for-tenant
post
/stripe/invoice-payment-succeded-for-tenant
post
Task
deliver all task whit te critery of search.
get
Creates a Task request.
post
Updates a Task request.
put
Delete a Task request.
del
Get all instances of a task. Can filter by Completed tasks instances, and also for a specific date.
get
Updates a Task request execution plan, eg: the days a specific task is going to be done.
put
Sets completion state to a task instance.
patch
Sets comments to a task instance.
patch
TaskInstance
/taskInstance/{id}
put
Delete Task Instance.
del
Team
/team
get
/team
post
Tenant
Get Tenant info based on ID
get
/tenant/getWithSettings/{id}
get
Get the location list for a given tenant id.
get
Add a new location to a tenant.
post
Deletes a tenant location given the tenant id and the location id.
del
Get paginated list of zip codes under a given location.
get
Add a new zip code to a tenant location given the tenant id, the location id and the zip code.
post
/tenant/{tenantId}/zipcode/{zip}/location
get
Removes a zip code from a tenant location given the tenant id, the location id and the zip code id.
del
Gets all services under a given location.
get
Creates a new service under a given location.
post
Gets all services for the given tenant under a given location.
get
Updates a service.
put
Gets all rates for a given service.
get
Creates a rate for the given service.
post
Gets all rates for a given tenant and service.
get
Updates a rate given its rate Id.
put
Register a new tenant.
post
/tenant/update-stripe-info
post
/tenant/bookingtenant/{status}
get
/tenant/remove/request/{id}
del
Gets the count of tenant's logged user not assigned requests.
get
/tenant/update
post
/tenant/updateSettings
post
/tenant/extrarate/{rateId}
del
/tenant/delete
del
/tenant/getclientsbytenant/{status}
get
/tenant/subscribe
post
/tenant/getCleaners
get
/tenant/getcleanersbytenant/{status}
get
Allows a Tenant to manually assign a cleaner to a Clean Home request.
post
Allows a Tenant to manually reassign a cleaner to a Clean Home request.
post
/cleaner/events/{cleanerId}
get
/cleaner/future-events/{cleanerId}
get
/cleaner/dismiss-and-reassign
post
/tenant/disconnect-from-stripe
post
/servicebot
get
Payments due to a cleaner within a time period.
get
Get the list of client sources for the authenticated tenant.
get
Add lead source to tenant.
post
Get the list of client sources for the given tenant.
get
Update a client lead source.
put
Delete a client lead source.
del
Feedback Ratings by tenant Id
get
Test
/test/email
get
/test/sms
get
/test/updateclients
get
/test/push
get
/test/logging
get
Timeline
/timeline/get
get
Creates a Timeline entry for cleaning a home
post
Deletes a Timeline entry
del
Timesheet
/timesheet/old-search
get
/timesheet/search
get
/timesheet/incentives
get
/timesheet/report
get
/timesheet/get/{id}
post
/timesheet/update
post
/timesheet/delete
post
/timesheet/clients
get
User
/user/getuser/{id}
get
Creates a Client lead.
post
Creates a Tenant Lead.
post
Webhook
/webhook/newlead
post
/webhook/newbooking
post
/webhook/eventchange
post
/webhook/cleanerchange
post
/webhook/remove
del
/webhook/samplelead
get
/webhook/samplebooking
get
/webhook/sampleeventstatuschange
get
/webhook/samplecleanerstatuschange
get
/webhook/clearbitresponse
post
Powered by
Add a new location to a tenant.
Ask AI
post
http://localhost:54224/tenant/
{tenantId}
/location
Language
Shell
Node
Ruby
PHP
Python
Response
Click
Try It!
to start a request and see the response here!
