Ashley DeBon: /* Successful Response (200) */

2026-07-17T08:03:34Z

‎Successful Response (200)

Ashley DeBon: Created page with "== Get Current Appointment == === Base URL === https://apimobile.callproof.com === Endpoint === /api/current-appointment === Purpose === Returns the authenticated user’s..."

2026-07-17T08:01:39Z

Created page with "== Get Current Appointment == === Base URL === https://apimobile.callproof.com === Endpoint === /api/current-appointment === Purpose === Returns the authenticated user’s..."

New page

== Get Current Appointment ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/current-appointment

=== Purpose ===
Returns the authenticated user’s currently active appointment, if one exists. When an appointment is in progress, the response includes appointment identifiers, timing, notes, and related contact/event form details. When no appointment is active, the response indicates that no appointment is currently in progress.

=== HTTP Method ===
GET

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
None.

==== Request Body ====
None.

=== Successful Response (200) ===
Indicates that the current appointment status was retrieved successfully.

==== When an appointment is active ====
{| class="wikitable"
! 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 || Current appointment payload
|-
| data.appointment_id || integer || Unique identifier of the active appointment
|-
| data.contact_id || integer || Contact associated with the appointment
|-
| data.created || string || Appointment created / start datetime (format: YYYY-MM-DD HH:MM:SS)
|-
| data.duration || integer || Appointment duration
|-
| data.notes || string || Appointment notes
|-
| data.updated_in_seconds || integer / string || Last updated time as a Unix timestamp
|-
| data.event_form_id || integer || Related event form identifier, or 0 if none
|-
| data.is_google_place || boolean || Whether the appointment contact is a Google Place account
|-
| data.is_appointment_active || integer || Indicates an active appointment (1)
|-
| uri || string || Requested resource URI
|}

==== When no appointment is active ====
{| class="wikitable"
! 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 || Appointment status payload
|-
| data.is_appointment_active || integer || Indicates no active appointment (0)
|-
| uri || string || Requested resource URI
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 400 || Bad Request – current appointment details could not be retrieved successfully
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''400''' – The service encountered an error while retrieving the current appointment.
* '''401''' – Authentication failed or the access token is missing/expired.

@@ Line 33: / Line 33: @@
 ==== Request Body ====
 None.
 === Successful Response (200) ===

Get Current Appointment for Current user - Revision history

Ashley DeBon: /* Successful Response (200) */

Ashley DeBon: Created page with "== Get Current Appointment == === Base URL === https://apimobile.callproof.com === Endpoint === /api/current-appointment === Purpose === Returns the authenticated user’s..."