agendapro_list_locations
List locations
List the business's locations (sucursales / locales): id, name, address, phone, email, timezone, opening hours and country. Location ids are needed for bookings, slots and sales filters. GET /v3/locations.
Parameterspageactiveper_page
agendapro_get_location
Get location
One location by id, with address, coordinates, timezone and weekly opening hours. GET /v3/locations/{id}.
Parameterslocation_idrequired
agendapro_list_services
List services
List the services (treatments, classes, sessions) the business offers: id, name, price, duration, type, category, whether online booking/payment is on, and the location. Service ids are needed to book. GET /v3/services.
Parameterspageper_pageprovider_id
agendapro_get_service
Get service
One service by id, including its category, images and the providers who perform it. GET /v3/services/{id}.
Parametersservice_idrequired
agendapro_list_service_categories
List service categories
List service categories, ordered as the business arranges them. GET /v3/categories.
Parameterspageper_page
agendapro_list_providers
List providers
List service providers (the staff who take bookings): id, public name, location, active flag, online-booking flag and working hours. Provider ids are needed to book. GET /v3/providers.
Parameterspageactivesort_byorder_byper_pagepublic_nameservice_idslocation_ids
agendapro_get_provider
Get provider
One service provider by id, with biography, images and working hours including breaks. GET /v3/providers/{id}.
Parametersprovider_idrequired
agendapro_list_bookings
List bookings
List bookings (reservas / appointments) with time, status, service, provider, client id, location, price and the linked sale. AgendaPro requires at least ONE of client_id, location_id, service_id or service_provider_id; dates only narrow the result. A sale may be a membership covering several bookings, so do not total amounts by sale id. GET /v3/bookings.
Parameterspageend_dateper_pageclient_idscheduledstatus_idservice_idstart_datelocation_idservice_provider_id
agendapro_get_booking
Get booking
One booking by id with status, service, provider, client id, location, prices, notes and the linked sale. GET /v3/bookings/{id}.
Parametersbooking_idrequired
agendapro_list_available_slots
List available slots
Free booking time windows at a location on one date (optionally for one service and/or provider): start/end time, provider, plus a metadata summary (service duration, slot count). Use before creating a booking. GET /v3/available_slots.
Parametersservice_idstart_daterequiredlocation_idrequiredprovider_id
agendapro_create_booking
Create booking
WRITE: create a booking for an existing client, service, provider and location. Check agendapro_list_available_slots first. status_id must be a non-cancelled status: copy the status.id of an existing booking (agendapro_list_bookings). AgendaPro does NOT send email/SMS/WhatsApp notifications for bookings created through the API. Not idempotent: calling twice books twice. POST /v3/bookings.
Parametersnotespriceend_timeclient_idrequiredstatus_idrequiredservice_idrequiredstart_timerequiredlocation_idrequiredprovider_idrequiredtime_resource_id
agendapro_update_booking
Update booking
WRITE: change an existing booking (partial update: only the fields you pass change): move it, switch service/provider/location, change status, price or notes. The merchant's customer policy applies: a change too close to the start time, or past the maximum number of changes, is refused with HTTP 422 and must not be retried. PATCH /v3/bookings/{id}.
Parametersnotespriceend_timeclient_idstatus_idbooking_idrequiredservice_idstart_timelocation_idprovider_idtime_resource_id
agendapro_cancel_booking
Cancel booking
WRITE: cancel a booking. This cannot be undone through the API. The merchant's customer policy applies: a cancellation that is disabled, too close to the start time or past the maximum number of changes is refused with HTTP 422 (tell the user the merchant does not allow it; do not retry). Confirm with the user before calling. PATCH /v3/bookings/{id}/cancel.
Parametersbooking_idrequired
agendapro_list_clients
List clients
List the business's clients (customers) page by page: name, email, phone, identification number, address, birth date, record number, active flag. Personal data: only use it for the task at hand. To find one person use agendapro_search_clients. GET /v3/clients.
Parameterspageper_page
agendapro_search_clients
Search clients
Find clients by free text (name, email, phone, identification number or record number): a short ranked list with id, full name, email, phone. The fastest way to get a client_id. GET /v3/clients/quick-search.
Parametersqrequiredlimit
agendapro_get_client
Get client
One client by id with contact details, address, birth date, record number and active flag. GET /v3/clients/{id}.
Parametersclient_idrequired
agendapro_list_client_custom_attributes
List a client's custom attributes
The custom attribute values stored for one client (id, name, datatype, value). GET /v3/clients/{id}/custom_attributes.
Parametersclient_idrequired
agendapro_list_custom_attributes
List custom attribute templates
The custom client fields the business defined (id, name, datatype, mandatory, group, choices). Use the template ids when setting custom_attributes on a client. GET /v3/custom_attributes.
Takes no parameters.
agendapro_create_client
Create client
WRITE: create a new client. first_name is required and at least one of last_name, email or phone must also be given (AgendaPro's rule). Search first (agendapro_search_clients) to avoid duplicates; not idempotent. No message is sent to the client. POST /v3/clients.
Parametersagecityemailphonegenderregionaddressdistrictbirth_daylast_namebirth_yearfirst_namerequired+3 more
agendapro_update_client
Update client
WRITE: change an existing client (partial update: only the fields you pass change; it overwrites the stored value). PATCH /v3/clients/{id}.
Parametersagecityemailphonegenderregionaddressdistrictbirth_dayclient_idrequiredlast_namebirth_year+4 more
agendapro_list_sales
List sales
List sales (ventas): status (partially_paid, paid, canceled, refunded), paid and pending amounts, paid-at time, location, client id and the payment transactions. Filter by paid date range, location or client. GET /v3/sales.
Parameterspageper_pageclient_idlocation_idpaid_at_endpaid_at_start
agendapro_get_sale
Get sale
One sale by id with amounts, status, location and its payment transactions (amount, paid-at, payment method). GET /v3/sales/{id}.
Parameterssale_idrequired
agendapro_list_products
List products
List retail products in the catalog: name, SKU, price, active flag, category, brand and display. GET /v3/products.
Parameterspageactivesearchper_pageproduct_brand_idproduct_display_idproduct_category_id
agendapro_get_product
Get product
One catalog product by id with description, SKU, price, category, brand and display. GET /v3/products/{id}.
Parametersproduct_idrequired