[#933] Filtering request on get/bookinglist : search parameter

API General
,
1

Migrated from Redmine #933 | Author: Marie Rajon
Status: New | Priority: Normal | Created: 2022-09-21

Hello,

In preparation of our workflow, I can’t find information about the search filtering parameter of the API REST (Documentation API | Réservation en ligne SimplyBook.me )
How can we use this parameter to filter bookings based on client data (such as name, email) ?
What is the search language to filter by client criterias ? which operators ?

Thank you for your help

2

Redmine Admin wrote:

hi, by link you sent:

 filter with following parameters:
upcoming_only - return upcomming bookings only
status - booking status (can be confirmed/confirmed_pending/pending/canceled)
services - array of service ids to filter by services
providers - array of provider ids to filter by providers
client_id - client id. to filter by client id
date - filter by date
search - search string (by code, client data)
additional_fields - search by additional fields (&filter[additional_fields][field] = value)
3

Marie Rajon wrote:

Hello,

I wanted to get more precision on the search criteria by client data. are all the client data searchable ? (every data of the client entity)

Thanks

4

Redmine Admin wrote:

hi, the only way to search clients is this method API documentation | SimplyBook.me Online Scheduling