Médicos — BestDoctorsRD API

GET/v1/doctors

List Doctors

Parámetros

Nombre	En	Tipo	Obl.
`tenant_id`	query	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de app__api__routes__doctors__DoctorOut
422	Error de validación	HTTPValidationError

POST/v1/doctors

Create Doctor

Cuerpo obligatorio `appapiroutesdoctorsDoctorCreateIn`

Campo	Tipo	Obl.
`tenant_id`	string o nulo	No
`branch_id`	string o nulo	No
`user_id`	string o nulo	No
`code`	string	Sí
`full_name`	string	Sí
`specialty`	string	Sí
`slug`	string o nulo	No
`bio`	string o nulo	No
`photo_url`	string o nulo	No
`education`	lista de string o nulo	No
`experienceYears`	integer o nulo	No
`languages`	lista de string o nulo	No
`locations`	lista de string o nulo	No
`services`	lista de string o nulo	No
`consultation_fee_cents`	integer	No
`accepts_virtual`	boolean	No
`acceptedInsurancePlanIds`	lista de string o nulo	No
`email`	string o nulo	No
`phone`	string o nulo	No
`exequatur`	string o nulo	No
`officeName`	string o nulo	No
`facebookUrl`	string o nulo	No
`instagramUrl`	string o nulo	No
`xUrl`	string o nulo	No
`linkedinUrl`	string o nulo	No
`websiteUrl`	string o nulo	No

Respuestas

Código	Descripción	Devuelve
201	Respuesta correcta	app__api__routes__doctors__DoctorOut
422	Error de validación	HTTPValidationError

GET/v1/doctors/analytics/workspace

Get Analytics Workspace

Parámetros

Nombre	En	Tipo	Obl.
`period`	query	string o nulo	No
`doctorId`	query	string o nulo	No
`tenantId`	query	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	DoctorAnalyticsWorkspaceOut
422	Error de validación	HTTPValidationError

GET/v1/doctors/billing/workspace

Get Billing Workspace

Parámetros

Nombre	En	Tipo	Obl.
`period`	query	string o nulo	No
`doctorId`	query	string o nulo	No
`tenantId`	query	string o nulo	No
`page`	query	integer	No
`pageSize`	query	integer	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	DoctorBillingWorkspaceOut
422	Error de validación	HTTPValidationError

GET/v1/doctors/dashboard/action-center

Get Dashboard Action Center

Parámetros

Nombre	En	Tipo	Obl.
`date`	query	string (date) o nulo	No
`doctorId`	query	string o nulo	No
`tenantId`	query	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	DoctorDashboardOut
422	Error de validación	HTTPValidationError

GET/v1/doctors/me

Get My Doctor Profile

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	app__api__routes__doctors__DoctorOut

PATCH/v1/doctors/me

Update My Doctor Profile

Cuerpo obligatorio `DoctorSelfUpdateIn`

Campo	Tipo	Obl.
`specialty`	string o nulo	No
`bio`	string o nulo	No
`photo_url`	string o nulo	No
`education`	lista de string o nulo	No
`experienceYears`	integer o nulo	No
`languages`	lista de string o nulo	No
`locations`	lista de string o nulo	No
`services`	lista de string o nulo	No
`consultation_fee_cents`	integer o nulo	No
`accepts_virtual`	boolean o nulo	No
`acceptedInsurancePlanIds`	lista de string o nulo	No
`email`	string o nulo	No
`phone`	string o nulo	No
`officeName`	string o nulo	No
`facebookUrl`	string o nulo	No
`instagramUrl`	string o nulo	No
`xUrl`	string o nulo	No
`linkedinUrl`	string o nulo	No
`websiteUrl`	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	app__api__routes__doctors__DoctorOut
422	Error de validación	HTTPValidationError

GET/v1/doctors/me/availability

Get My Doctor Availability

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	DoctorAvailabilityOut

PATCH/v1/doctors/me/availability

Update My Doctor Availability

Cuerpo obligatorio `DoctorAvailabilityPatchIn`

Campo	Tipo	Obl.
`schedules`	lista de DoctorScheduleIn o nulo	No
`locations`	lista de DoctorPracticeLocationIn o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	DoctorAvailabilityOut
422	Error de validación	HTTPValidationError

GET/v1/doctors/me/documents

List My Doctor Documents

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de DoctorDocumentOut

POST/v1/doctors/me/documents

Upload My Doctor Document

Cuerpo obligatorio `DoctorDocumentUploadIn`

Campo	Tipo	Obl.
`documentType`	string	Sí
`storageKey`	string	Sí
`fileName`	string o nulo	No
`mimeType`	string o nulo	No
`sizeBytes`	integer o nulo	No
`expirationDate`	string (date) o nulo	No

Respuestas

Código	Descripción	Devuelve
201	Respuesta correcta	DoctorDocumentOut
422	Error de validación	HTTPValidationError

GET/v1/doctors/me/onboarding

Get My Doctor Onboarding

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	DoctorOnboardingOut

POST/v1/doctors/me/onboarding/reminders

Queue My Doctor Onboarding Reminder

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	DoctorOnboardingReminderOut

PATCH/v1/doctors/me/onboarding/steps/{step}

Complete My Doctor Onboarding Step

Parámetros

Nombre	En	Tipo	Obl.
`step`	path	string	Sí

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	DoctorOnboardingOut
422	Error de validación	HTTPValidationError

GET/v1/doctors/me/profile

Get My Professional Profile

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	DoctorProfessionalProfileOut

PATCH/v1/doctors/me/profile

Update My Professional Profile

Cuerpo obligatorio `DoctorProfessionalProfilePatchIn`

Campo	Tipo	Obl.
`licenseNumber`	string o nulo	No
`exequaturNumber`	string o nulo	No
`specialtyIds`	lista de string o nulo	No
`services`	lista de string o nulo	No
`education`	lista de string o nulo	No
`experience`	integer o nulo	No
`languages`	lista de string o nulo	No
`locations`	lista de string o nulo	No
`publicBio`	string o nulo	No
`photoUrl`	string o nulo	No
`acceptsVirtual`	boolean o nulo	No
`consultationFeeCents`	integer o nulo	No
`email`	string o nulo	No
`phone`	string o nulo	No
`officeName`	string o nulo	No
`websiteUrl`	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	DoctorProfessionalProfileOut
422	Error de validación	HTTPValidationError

GET/v1/doctors/me/schedule

List My Doctor Schedule

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de DoctorScheduleOut

PUT/v1/doctors/me/schedule

Replace My Doctor Schedule

Cuerpo obligatorio `DoctorScheduleBulkIn`

Campo	Tipo	Obl.
`schedules`	lista de DoctorScheduleIn	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de DoctorScheduleOut
422	Error de validación	HTTPValidationError

GET/v1/doctors/me/time-off

List My Doctor Time Off

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de DoctorTimeOffOut

POST/v1/doctors/me/time-off

Create My Doctor Time Off

Cuerpo obligatorio `DoctorTimeOffIn`

Campo	Tipo	Obl.
`startsAt`	string (date-time)	Sí
`endsAt`	string (date-time)	Sí
`type`	string	No
`reason`	string o nulo	No

Respuestas

Código	Descripción	Devuelve
201	Respuesta correcta	DoctorTimeOffOut
422	Error de validación	HTTPValidationError

DELETE/v1/doctors/me/time-off/{time_off_id}

Delete My Doctor Time Off

Parámetros

Nombre	En	Tipo	Obl.
`time_off_id`	path	string	Sí

Respuestas

Código	Descripción	Devuelve
204	Respuesta correcta	—
422	Error de validación	HTTPValidationError

GET/v1/doctors/{doctor_id}

Get Doctor

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	app__api__routes__doctors__DoctorOut
422	Error de validación	HTTPValidationError

PATCH/v1/doctors/{doctor_id}

Update Doctor

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí

Cuerpo obligatorio `DoctorUpdateIn`

Campo	Tipo	Obl.
`branch_id`	string o nulo	No
`user_id`	string o nulo	No
`code`	string o nulo	No
`full_name`	string o nulo	No
`specialty`	string o nulo	No
`slug`	string o nulo	No
`bio`	string o nulo	No
`photo_url`	string o nulo	No
`education`	lista de string o nulo	No
`experienceYears`	integer o nulo	No
`languages`	lista de string o nulo	No
`locations`	lista de string o nulo	No
`services`	lista de string o nulo	No
`consultation_fee_cents`	integer o nulo	No
`accepts_virtual`	boolean o nulo	No
`acceptedInsurancePlanIds`	lista de string o nulo	No
`email`	string o nulo	No
`phone`	string o nulo	No
`exequatur`	string o nulo	No
`officeName`	string o nulo	No
`facebookUrl`	string o nulo	No
`instagramUrl`	string o nulo	No
`xUrl`	string o nulo	No
`linkedinUrl`	string o nulo	No
`websiteUrl`	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	app__api__routes__doctors__DoctorOut
422	Error de validación	HTTPValidationError

DELETE/v1/doctors/{doctor_id}

Delete Doctor

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí

Respuestas

Código	Descripción	Devuelve
204	Respuesta correcta	—
422	Error de validación	HTTPValidationError

GET/v1/doctors/{doctor_id}/insurances

List Doctor Insurances

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de DoctorInsuranceOut
422	Error de validación	HTTPValidationError

POST/v1/doctors/{doctor_id}/insurances

Add Doctor Insurance

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí

Cuerpo obligatorio `DoctorInsuranceIn`

Campo	Tipo	Obl.
`insurance_plan_id`	string	Sí

Respuestas

Código	Descripción	Devuelve
201	Respuesta correcta	DoctorInsuranceOut
422	Error de validación	HTTPValidationError

DELETE/v1/doctors/{doctor_id}/insurances/{insurance_id}

Delete Doctor Insurance

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí
`insurance_id`	path	string	Sí

Respuestas

Código	Descripción	Devuelve
204	Respuesta correcta	—
422	Error de validación	HTTPValidationError

PATCH/v1/doctors/{doctor_id}/publish

Publish Doctor

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí

Cuerpo obligatorio `DoctorPublishIn`

Campo	Tipo	Obl.
`isPublished`	boolean	Sí

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	app__api__routes__doctors__DoctorOut
422	Error de validación	HTTPValidationError

GET/v1/doctors/{doctor_id}/reviews

List Doctor Reviews

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí
`status`	query	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de DoctorReviewOut
422	Error de validación	HTTPValidationError

GET/v1/doctors/{doctor_id}/schedule

List Doctor Schedule

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de DoctorScheduleOut
422	Error de validación	HTTPValidationError

POST/v1/doctors/{doctor_id}/schedule

Upsert Doctor Schedule

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí

Cuerpo obligatorio `DoctorScheduleIn`

Campo	Tipo	Obl.
`dayOfWeek`	integer	Sí
`startsAt`	string	Sí
`endsAt`	string	Sí
`slotDurationMinutes`	integer	No
`isActive`	boolean	No
`branchId`	string o nulo	No
`modality`	string	No

Respuestas

Código	Descripción	Devuelve
201	Respuesta correcta	DoctorScheduleOut
422	Error de validación	HTTPValidationError

PUT/v1/doctors/{doctor_id}/schedule

Replace Doctor Schedule

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí

Cuerpo obligatorio `DoctorScheduleBulkIn`

Campo	Tipo	Obl.
`schedules`	lista de DoctorScheduleIn	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de DoctorScheduleOut
422	Error de validación	HTTPValidationError

PATCH/v1/doctors/{doctor_id}/schedule/{schedule_id}

Update Doctor Schedule

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí
`schedule_id`	path	string	Sí

Cuerpo obligatorio `DoctorScheduleIn`

Campo	Tipo	Obl.
`dayOfWeek`	integer	Sí
`startsAt`	string	Sí
`endsAt`	string	Sí
`slotDurationMinutes`	integer	No
`isActive`	boolean	No
`branchId`	string o nulo	No
`modality`	string	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	DoctorScheduleOut
422	Error de validación	HTTPValidationError

curl

curl -X PATCH "https://api.bestdoctorsrd.com/v1/doctors/{doctor_id}/schedule/{schedule_id}" \
  -H "Content-Type: application/json" \
  -d '{ "dayOfWeek": …, "startsAt": …, "endsAt": … }'

DELETE/v1/doctors/{doctor_id}/schedule/{schedule_id}

Delete Doctor Schedule

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí
`schedule_id`	path	string	Sí

Respuestas

Código	Descripción	Devuelve
204	Respuesta correcta	—
422	Error de validación	HTTPValidationError

GET/v1/doctors/{doctor_id}/time-off

List Doctor Time Off

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de DoctorTimeOffOut
422	Error de validación	HTTPValidationError

POST/v1/doctors/{doctor_id}/time-off

Create Doctor Time Off

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí

Cuerpo obligatorio `DoctorTimeOffIn`

Campo	Tipo	Obl.
`startsAt`	string (date-time)	Sí
`endsAt`	string (date-time)	Sí
`type`	string	No
`reason`	string o nulo	No

Respuestas

Código	Descripción	Devuelve
201	Respuesta correcta	DoctorTimeOffOut
422	Error de validación	HTTPValidationError

DELETE/v1/doctors/{doctor_id}/time-off/{time_off_id}

Delete Doctor Time Off

Parámetros

Nombre	En	Tipo	Obl.
`doctor_id`	path	string	Sí
`time_off_id`	path	string	Sí

Respuestas

Código	Descripción	Devuelve
204	Respuesta correcta	—
422	Error de validación	HTTPValidationError

List Doctors

Parámetros

Respuestas

Create Doctor

Cuerpo obligatorio app__api__routes__doctors__DoctorCreateIn

Respuestas

Get Analytics Workspace

Parámetros

Respuestas

Get Billing Workspace

Parámetros

Respuestas

Get Dashboard Action Center

Parámetros

Respuestas

Get My Doctor Profile

Respuestas

Update My Doctor Profile

Cuerpo obligatorio DoctorSelfUpdateIn

Respuestas

Get My Doctor Availability

Respuestas

Update My Doctor Availability

Cuerpo obligatorio DoctorAvailabilityPatchIn

Respuestas

List My Doctor Documents

Respuestas

Upload My Doctor Document

Cuerpo obligatorio DoctorDocumentUploadIn

Respuestas

Get My Doctor Onboarding

Respuestas

Queue My Doctor Onboarding Reminder

Respuestas

Complete My Doctor Onboarding Step

Parámetros

Respuestas

Get My Professional Profile

Respuestas

Update My Professional Profile

Cuerpo obligatorio DoctorProfessionalProfilePatchIn

Respuestas

List My Doctor Schedule

Respuestas

Replace My Doctor Schedule

Cuerpo obligatorio DoctorScheduleBulkIn

Respuestas

List My Doctor Time Off

Respuestas

Create My Doctor Time Off

Cuerpo obligatorio DoctorTimeOffIn

Respuestas

Delete My Doctor Time Off

Parámetros

Respuestas

Get Doctor

Parámetros

Respuestas

Update Doctor

Parámetros

Cuerpo obligatorio DoctorUpdateIn

Respuestas

Delete Doctor

Parámetros

Respuestas

List Doctor Insurances

Parámetros

Respuestas

Add Doctor Insurance

Parámetros

Cuerpo obligatorio DoctorInsuranceIn

Respuestas

Delete Doctor Insurance

Parámetros

Respuestas

Publish Doctor

Parámetros

Cuerpo obligatorio DoctorPublishIn

Respuestas

List Doctor Reviews

Cuerpo obligatorio `appapiroutesdoctorsDoctorCreateIn`

Cuerpo obligatorio `DoctorSelfUpdateIn`

Cuerpo obligatorio `DoctorAvailabilityPatchIn`

Cuerpo obligatorio `DoctorDocumentUploadIn`

Cuerpo obligatorio `DoctorProfessionalProfilePatchIn`

Cuerpo obligatorio `DoctorScheduleBulkIn`

Cuerpo obligatorio `DoctorTimeOffIn`

Cuerpo obligatorio `DoctorUpdateIn`

Cuerpo obligatorio `DoctorInsuranceIn`

Cuerpo obligatorio `DoctorPublishIn`

Cuerpo obligatorio `DoctorScheduleIn`

Cuerpo obligatorio `DoctorScheduleBulkIn`

Cuerpo obligatorio `DoctorScheduleIn`

Cuerpo obligatorio `DoctorTimeOffIn`