patients

Patients search (CRM)

Changed on

Operator/CRM patient search — same scoping as /patients/search (the requester's assigned patients) plus a free-text name query, powering the expert app's patient pickers.

get/api/patients/crm/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/patients/crm/search
  • Auth: HTTP bearer

Query parameters

querystring nullable

Free-text search: first name, last name, either order, or email.

limitinteger

Max rows to return.

patient_idstring uuid nullable

Patient UUID

user_idstring uuid nullable

Patient user UUID

psychologist_idstring uuid nullable

Psychologist operator UUID

nutritionist_idstring uuid nullable

Nutritionist operator UUID

Response

Successful Response

idstring uuid required
user_idstring uuid required
psychologist_idstring uuid nullable
nutritionist_idstring uuid nullable
statusobject
stripe_customer_idstring nullable
workflow_followups_enabledboolean
payment_methodstring nullable
payment_method_typestring nullable
deductionboolean nullable
created_atstring date-time nullable
third_party_consentboolean
intro_call_atstring date-time nullable

When the patient's intro call actually happened: the earliest CALL_CONOSCITIVA marked FATTO, by the slot's own datetime. Null when they never completed one.

journey_started_atstring date-time nullable

When the patient's path began: the earliest expert assignment on record, whichever discipline. Null while nobody has taken them on.

first_psychologist_atstring date-time nullable

The patient's first psychologist session that was not cancelled or refunded (a congiunto counts under its expert's discipline). Null when there is none.

first_nutritionist_atstring date-time nullable

As first_psychologist_at, for the nutritionist.

spent_totalnumber

Sum of patient_cost over the appointments paid so far (payment_status succeeded, coupons included), every type.

spent_psychologistnumber

As spent_total, psychologist sessions only (congiunto included).

spent_nutritionistnumber

As spent_total, nutritionist sessions only (congiunto included).

Changes

    • ○

      added the optional property / to the response with the status

    • ○

      added the optional property / to the response with the status

    • ○

      added the optional property / to the response with the status

    • ○

      added the optional property / to the response with the status

    • ○

      added the optional property / to the response with the status

    • ○

      added the optional property / to the response with the status

    • ○

      added the optional property / to the response with the status