Filtering (Criteria)

Most list endpoints support an advanced filtering system via query parameters. This system lets you build complex queries by combining multiple filters.

Filter structure

Each filter is an object with three properties:

Property	Type	Description
`field`	`string`	Name of the field to filter
`operator`	`string`	Comparison operator
`value`	`string \| string[]`	Value or values to compare

Available operators

Operator	Description	`value` type
`=`	Equal to	`string`
`!=`	Not equal to	`string`
`>`	Greater than	`string`
`>=`	Greater than or equal	`string`
`<`	Less than	`string`
`<=`	Less than or equal	`string`
`CONTAINS`	Contains (partial match)	`string`
`NOT_CONTAINS`	Does not contain	`string`
`IN`	In list	`string[]`
`NOT_IN`	Not in list	`string[]`

Pagination and sort parameters

Parameter	Type	Default	Description
`filters`	`array`	`[]`	Array of filters
`orderBy`	`string`	`null`	Field to sort by
`order`	`string`	`null`	Direction: `asc`, `desc` or `none`
`limit`	`integer`	`25`	Results per page (max 100)
`offset`	`integer`	`0`	Result offset

Example request with filters

GET /v1/bookings?filters[0][field]=status&filters[0][operator]==&filters[0][value]=confirmed&filters[1][field]=startTime&filters[1][operator]=>=&filters[1][value]=2026-03-05T00:00:00Z&orderBy=startTime&order=asc&limit=10&offset=0

Filtering by Custom Fields

Bookings and Clients endpoints allow filtering by custom fields using the field UUID as the field value. This enables dynamic filters based on custom fields defined by the business.

GET /v1/clients?filters[0][field]=a1b2c3d4-e5f6-7890-abcd-ef1234567890&filters[0][operator]==&filters[0][value]=premium

To get the list of available custom fields and their UUIDs, see the GET /custom-fields endpoint.

Filterable fields by resource

Bookings

Field	Description
`id`	Booking UUID
`startTime`	Start date/time
`endTime`	End date/time
`status`	Booking status
`internalNote`	Internal note
`clientNote`	Client note
`paymentStatus`	Payment status
`isFromWeb`	Created from web
`isFromAgent`	Created by IA agent
`amount`	Amount
`clientId`	Client UUID
`paymentId`	Payment UUID
`locationId`	Location UUID
`serviceId`	Service UUID
`personId`	Professional UUID
`createdAt`	Created at
`client`	Client name (search)
`clientCustomField`	Client custom field
`clientPhone`	Client phone
`clientDocNumber`	Client document number
`clientBirthdate`	Client birthdate
`clientCountry`	Client country
`clientState`	Client state
`clientCity`	Client city
`{uuid}`	Custom field UUID

Clients

Field	Description
`id`	Client UUID
`fullname`	Full name
`email`	Email
`phone`	Phone
`docType`	Document type
`docNumber`	Document number
`birthdate`	Birthdate
`address`	Address
`city`	City
`state`	State/Province
`country`	Country
`{uuid}`	Custom field UUID

Locations

Field	Description
`name`	Location name
`code`	Code
`status`	Status

Services

Field	Description
`id`	Service UUID
`name`	Name
`duration`	Duration in minutes
`domiciliary`	At-home service
`virtual`	Virtual
`status`	Status
`price`	Price
`categoryId`	Category UUID
`description`	Description
`sessions`	Number of sessions
`simultaneous`	Simultaneous bookings

People (Professionals)

Field	Description
`locationId`	Location UUID
`fullname`	Full name
`email`	Email
`status`	Status
`phone`	Phone
`idType`	ID type
`idNumber`	ID number
`birthdate`	Birthdate
`userId`	Associated user UUID
`service.id`	Associated service UUID

Calendar Events

Field	Description
`id`	Event UUID
`type`	Event type (`booking`, `time_block`)
`startTime`	Start date/time
`endTime`	End date/time
`locationId`	Location UUID
`providerId`	Professional UUID