Pular para o conteúdo principal
POST
Search for appointments using filters, sorting, and pagination to retrieve specific records.

Supported products

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de caminho

objectType
string
obrigatório

Corpo

application/json

Describes a search request

after
string
obrigatório

A paging cursor token for retrieving subsequent pages.

filterGroups
object[]
obrigatório

Up to 6 groups of filters defining additional query criteria.

limit
integer<int32>
obrigatório

The maximum results to return, up to 200 objects.

properties
string[]
obrigatório

A list of property names to include in the response.

sorts
string[]
obrigatório

Specifies sorting order based on object properties.

query
string

The search query string, up to 3000 characters.

Resposta

successful operation

Represents a list of simple objects returned from an API request, along with the total count of objects available.

results
object[]
obrigatório

An array containing the simple public objects returned in the current page of the response. This property is required.

total
integer<int32>
obrigatório

The number of available results

paging
object

Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.

Última modificação em 13 de abril de 2026