Get EndAppointment Details for Current user

Get End Appointment Details

Base URL

https://apimobile.callproof.com

Endpoint

/api/end-appointment

Purpose

Retrieves the details needed to end / check out of the authenticated user’s currently active appointment. The response includes the appointment and contact information, custom fields, notes, and related checkout sections so the user can review and complete the appointment before ending it.

HTTP Method

GET

Headers

Header	Required	Description
Authorization	Yes	Bearer access token

Security

• Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

None.

Query Parameters

Parameter	Type	Required	Description
latitude	string	No	User’s current latitude, used to calculate distance to the appointment contact
longitude	string	No	User’s current longitude, used to calculate distance to the appointment contact

Request Body

None.

Successful Response (200)

Indicates that end-appointment details were retrieved successfully. If no appointment is currently active, data may be returned as an empty list.

Field	Type	Description
clientStatusCode	integer	Status indicator for the client (for example, 200)
user_id	integer	Identifier of the authenticated user
company_id	integer	Identifier of the authenticated user’s company
data	object / array	End-appointment payload when an appointment is active; empty when no appointment is active
data.appointment_id	integer	Unique identifier of the active appointment
data.contact_id	integer	Contact associated with the appointment
data.event_form_id	integer	Related event form identifier, or 0 if none
data.event_form_name	string	Related event form name, or "Default Appointment" when no event form is linked
data.contact_view	object	Summary details of the appointment contact
data.contact_view.contact_id	integer	Contact identifier
data.contact_view.company_name	string	Company / account name
data.contact_view.address1	string	Primary street address
data.contact_view.address2	string	Secondary street address
data.contact_view.city	string	City
data.contact_view.state	string	State abbreviation
data.contact_view.zipcode	string	Postal / ZIP code
data.contact_view.country	string	Country name
data.contact_view.last_contacted	string	Date/time the contact was last contacted, or "Never"
data.contact_view.distance	string	Distance from the user’s location to the contact
data.contact_view.contact_image	string	Image URL for the contact or contact type
data.custom_fields	array	Custom fields associated with the contact for checkout
data.custom_fields[].id	integer	Custom field identifier
data.custom_fields[].name	string	Custom field label
data.custom_fields[].position	integer	Display order position
data.custom_fields[].required	boolean	Whether the field is required
data.custom_fields[].value	string	Current value for the custom field
data.notes	string	Existing appointment notes
data.treat_event_form_as_appointment	array	Placeholder section for treat-as-appointment event form options
data.selected_people	array	Placeholder section for people selected during checkout
data.add_task_or_follow_up	array	Placeholder section for task / follow-up options during checkout
uri	string	Requested resource URI

Error Responses

Status Code	Meaning
400	Bad Request – end-appointment details could not be retrieved (for example, appointment contact not found or processing error)
401	Unauthorized – missing, invalid, or expired Bearer token

• 400 – The appointment’s contact was not found, or another error occurred while retrieving end-appointment details.
• 401 – Authentication failed or the access token is missing/expired.