operators

Search Operators

Changed on
get/api/operators/search

Request

  • Base URL: https://api.corabea.it (the document declares no server; this is the origin it was published from)
  • URL: https://api.corabea.it/api/operators/search
  • Auth: HTTP bearer

Query parameters

qstring nullable

Free text matched against operator name or email. Omit to browse with the filters alone instead of searching.

limitinteger

Maximum number of operators returned.

profession'PSICOLOGO' | 'NUTRIZIONISTA'

Operator profession constants.

If set, only operators with this profession are returned.

operator_status'active' | 'inactive' | 'onboarding' | 'pending_approval'

Operator status constants. Onboarding and pending operators can log in (Keycloak enabled) but are not active: every "is this operator active" gate excludes them, and the portal is locked to the onboarding page.

If set, only operators in this status. active is the drill-down behind the dashboard's stats.operators_active card.

supervisors_onlyboolean

Keep only operators supervising at least one other operator — with operator_status=active, the drill-down behind the dashboard's stats.supervisors_active card.

include_supervisorsboolean

If true, each operator includes supervisor_names (comma-separated display names). Ignored unless the caller holds OPERATORS_READ.

Response

Successful Response

user_idstring uuid nullable
vat_codestring nullable
ssn_codestring nullable
pecstring nullable
tax_regimestring nullable
billing_namestring nullable

Billing name (ragione sociale) used for invoicing; when set it replaces first/last name on Zucchetti

professionstring nullable
ibanstring nullable
work_placestring nullable
biostring nullable
professional_registration_numberstring nullable
professional_sectionstring nullable
regional_professional_orderstring nullable
statusstring nullable
status_reasonstring nullable
professional_insurance_expires_atstring date nullable
accepts_new_patientsboolean nullable
in_person_availabilityboolean

Disponibile per pazienti in presenza: declared profile preference, independent of calendar availability

default_appointment_costnumber nullable
operator_costnumber nullable
max_patientsinteger nullable
call_durationinteger nullable
presentation_videostring nullable
spoki_keystring nullable
spoki_emailstring nullable
slack_user_idstring nullable
idstring uuid required
created_atstring nullable
updated_atstring nullable
has_in_person_availabilityboolean
assignments_blocked_atstring date-time nullable

Set while an admin or supervisor blocks new patient assignments on this expert

assignments_block_reasonstring nullable

Why new assignments are blocked; shown wherever the expert cannot be picked

supervisor_namesstring nullable
assigned_patients_countinteger nullable

Patients with this operator as psychologist or nutritionist; list and profile only

coordinator_namesstring nullable

Comma-separated coordinators of the operator's supervisors; with include_supervisors only

handover_idstring uuid nullable

The operator's riassegnazione, if any. Open or closed: handover_closed_at is what says which.

handover_due_atstring nullable

Due time of that riassegnazione, when it has one.

handover_closed_atstring nullable

When it was closed. Null means open, so the section is still active for the operator and they cannot be deactivated yet.

handover_kindstring nullable

departure | return, for that riassegnazione.

handover_ends_atstring nullable

End of the leave, when it is a temporary replacement — 'in sostituzione fino al'.

Changes

  • 2af59bd2c0e6Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • ab501b8b91e7Revision changes
    • info

      added the optional property / to the response with the status