Ir al contenido

Get Appointment

Ver como Markdown
GET
/public/v1/appointments/{appointment_id}
curl --request GET \
--url https://api.aymaragents.com/public/v1/appointments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'X-API-Key: <X-API-Key>'

Return a single appointment owned by the tenant – new endpoint (module docstring), reusing AppointmentService.get_appointment (already used internally by update_appointment, no duplicated lookup logic).

Foreign/unknown appointmentId -> 404.


Permiso necesario: tenant:appointments.read

appointment_id
required
Appointment Id
string format: uuid

Successful Response

Media typeapplication/json
PublicAppointmentOut

A single appointment, curated subset of the internal AppointmentOut.

Drops googleEventId (CAL-11 internal Google Calendar mirror id, meaningless to a third party) and createdBy (the internal actor id – Platform-only attribution; a public caller already knows who acted, it was its own key).

object
id
required
Id
string
assignedUserId
required
Assigneduserid
string
customerId
Any of:
string
conversationId
Any of:
string
leadId
Any of:
string
title
required
Title
string
appointmentType
required
Appointmenttype
string
startsAt
required
Startsat
string
endsAt
required
Endsat
string
status
required
Status
string
source
required
Source
string
notes
Any of:
string
createdAt
required
Createdat
string
updatedAt
required
Updatedat
string

Examplegenerated

{
"id": "example",
"assignedUserId": "example",
"customerId": "example",
"conversationId": "example",
"leadId": "example",
"title": "example",
"appointmentType": "example",
"startsAt": "example",
"endsAt": "example",
"status": "example",
"source": "example",
"notes": "example",
"createdAt": "example",
"updatedAt": "example"
}

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

Examplegenerated

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