Skip to content

Get self-scheduling attempt

Request

Retrieve details of an existing self-scheduling attempt by ID. Returns attempt status including identity proof verification status, patient ID (if set), and appointment ID (if created). Returns 404 if attempt doesn't exist or doesn't belong to this account.

Security
PartnerApiKey and PartnerOAuth
Path
attemptIdinteger, (int64)required
curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/self-scheduling/attempt/{attemptId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Self-scheduling attempt retrieved successfully

Bodyapplication/json
appointmentIdinteger, (int64)

Appointment ID if appointment has been created. Omitted if not yet created.

Example:202
idinteger, (int64)

Attempt ID

Example:789
identityProofIdinteger, (int64)

Associated identity proof ID

Example:456
isVerifiedboolean

Whether all required verification methods have been completed

Example:true
patientIdinteger, (int64)

Patient ID if patient has been set (AccountPatient ID). Omitted if not yet set.

Example:101
selfSchedulingSettingIdinteger, (int64)

Associated self-scheduling setting ID

Example:123
Response
{
  "appointmentId": 202,
  "id": 789,
  "identityProofId": 456,
  "isVerified": true,
  "patientId": 101,
  "selfSchedulingSettingId": 123
}