Planity API
14 endpoints for Planity, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.
- Base URL
- https://cotlet.dev/api/v1/planity
- Connects with
- Your own Planity Pro account, with access to the Agenda, Clients and Admin tabs
- Integration page
- Planity
Read (8)
Return data and change nothing in the account.
| Endpoint | Description |
|---|---|
| GET | Reads the appointments of the Agenda tab for a date range, for the whole salon or one staff member. |
| GET | Reads one appointment with its notes, extra services and the client's contact details. |
| GET | Searches the Clients tab by name and returns matching client records. |
| GET | Reads one client record with upcoming and past appointments and the technical sheet. |
| GET | Lists the services (prestations) the salon offers with their duration. |
| GET | Lists the staff members (collaborateurs) whose agenda columns the salon runs. |
| GET | Reads Admin > Statistiques RDV for a period: bookings, online share, new clients, no-shows, per service and per staff member. |
| GET | Lists appointments marked "Pas venu" in the agenda for a date range, as the tab RDV pas venus does. |
Write (6)
Change the account. Calls marked Confirm wait for the user to approve them.
| Endpoint | Description |
|---|---|
| POST | Adds an appointment to the agenda the way you do for a client who books by phone. |
| PATCH | Changes the date, time, service, staff member or notes of an existing appointment. |
| DELETE | Deletes one appointment from the agenda with Supprimer. |
| POST | Blocks a staff member's agenda for a period, once or repeating, so no client can book online in it. |
| DELETE | Removes a block made with block_time, so the time can be booked online again. |
| PUT | Ticks or clears "Empêcher ce client de prendre RDV en ligne" on a client record. |