Read an authorized appointment detail

GET

/v1/mobile/receptionist/activity/appointments/{appointment_id}

curl --request GET \
  --url https://api.vocapable.com/v1/mobile/receptionist/activity/appointments/example \
  --header 'Authorization: Bearer <token>'

Read by opaque activity id, with the repository’s tenant predicate in every query.

Authorizations

• MobileBearer

Parameters

Path Parameters

appointment_id

required

Appointment Id

string

Responses

200

Successful Response

Media typeapplication/json

MobileAppointment

A mobile appointment receipt without contact, attendee, or provider identifiers.

object

id

required

Id

string

call_id

required

Call Id

string

starts_at

required

Starts At

string format: date-time

ends_at

required

Ends At

string format: date-time

contact_timezone

Any of:

string

string

null

null

status

required

Status

string

Allowed values: booked rescheduled cancelled completed no_show

invite_sent_at

Any of:

string

string format: date-time

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

Example

{
  "status": "booked"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}