Skip to main content
The List Professional Schedules endpoint returns a paginated collection of schedules for all professionals configured in your clinic. Each schedule describes a professional’s working hours broken down by day of the week, their default appointment slot duration, and their timezone. Use this endpoint to display professional availability templates, build configuration UIs, or synchronise schedule data to an external calendar system.

Endpoint

Authentication

Query Parameters

integer
default:"20"
Maximum number of schedule records to return per page. Accepted range is 1100.
string
Opaque pagination cursor returned as next_cursor in the previous response. Omit this parameter to start from the first page.
string
Filter results to the schedule belonging to a specific professional UUID. Returns a single-item list when the professional exists.

Response Fields

data array — Schedule object

string
required
Unique identifier for the schedule (UUID v4).
string
required
UUID of the professional this schedule belongs to.
string
required
Display name of the professional.
string
required
Medical or healthcare specialty of the professional, e.g. "Cardiologia".
array
required
Array of objects describing the professional’s recurring weekly working windows.
integer
required
Default appointment slot duration in minutes. Used by GET /schedules/availability when no duration override is specified.
string
required
IANA timezone identifier for the professional’s clinic location, e.g. "America/Sao_Paulo". All start_time and end_time values in working_hours are relative to this timezone.

meta object

integer
required
Total number of schedules matching the current query.
boolean
required
true when there are additional pages of results.
string
Cursor to pass on the next request. Present only when has_more is true.
The working_hours array reflects the professional’s configured recurring schedule in ByDoctor — it does not account for blocked time, holidays, or already-booked appointments. To find real-time open slots for a specific date, use GET /schedules/availability instead.

Error Responses

Example Request

Example Response