GET
/
consultations
/
{consultation_id}
cURL
curl --request GET \
  --url http://localhost:8080/consultations/{consultation_id}
{
  "benefit_id": "<string>",
  "benefit_provider_id": "<string>",
  "created_at": "<string>",
  "dependant_id": "<string>",
  "id": "<string>",
  "last_modified_at": "<string>",
  "primary_user_id": "012345678901",
  "primary_user_phone_number": "<string>",
  "benefit_name": "<string>",
  "benefit_provider_name": "<string>",
  "dependant_first_name": "<string>",
  "dependant_last_name": "<string>",
  "external_reference_id": "<string>",
  "primary_user_first_name": "<string>",
  "primary_user_last_name": "<string>",
  "primary_user_phone_country_code": "<string>"
}

Path Parameters

​
consultation_id
string
required

Consultation UUID

Response

Consultation found

​
benefit_id
string
required
​
benefit_provider_id
string
required
​
created_at
string
required
​
dependant_id
string
required
​
id
string
required
​
last_modified_at
string
required
​
primary_user_id
string
required

A validated 12-digit numeric user identifier.

Every external entry point validates:

  • JSON Deserialize runs [UserId::parse] (outer whitespace trimmed, length and digit-only enforced) via #[serde(try_from = "String")].
  • DB FromSql runs [UserId::parse] on every row read.

Display / Deref<Target = str> / AsRef<str> / Into<String> are derived via derive_more — the inner String is pass-through for every read-only borrow, display, and move-out.

Example:

"012345678901"

​
primary_user_phone_number
string
required
​
status
enum<string>
required

Consultation lifecycle status. INITIATED = row inserted, upstream thread not yet created (transient or stuck). ACTIVE = upstream thread open (mirrors chatStatusCategory OPEN). COMPLETED = doctor marked done (mirrors DONE). CLOSED = archived (mirrors CLOSED). FAILED = upstream create_thread errored after our INSERT; not visible to FE.

Available options:
INITIATED,
ACTIVE,
COMPLETED,
CLOSED,
FAILED
​
benefit_name
string | null
​
benefit_provider_name
string | null
​
dependant_first_name
string | null
​
dependant_last_name
string | null
​
external_reference_id
string | null
​
primary_user_first_name
string | null
​
primary_user_last_name
string | null
​
primary_user_phone_country_code
string | null