Ashley DeBon: /* Fetch User Appointments */

2026-07-21T15:34:58Z

‎Fetch User Appointments

Ashley DeBon: Created page with "== Fetch User Appointments == === Base URL === https://apimobile.callproof.com === Endpoint === /api/ai/chat-bot/fetch-user-appointment === Purpose === Retrieves appointmen..."

2026-07-21T15:34:24Z

Created page with "== Fetch User Appointments == === Base URL === https://apimobile.callproof.com === Endpoint === /api/ai/chat-bot/fetch-user-appointment === Purpose === Retrieves appointmen..."

New page

== Fetch User Appointments ==

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

=== Endpoint ===
/api/ai/chat-bot/fetch-user-appointment

=== Purpose ===
Retrieves appointments for a specific user within a company for a given date range. Optionally filters to completed or incomplete appointments (based on whether the appointment was ended with Plus).

=== HTTP Method ===
POST

=== 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 ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| userId || integer || Yes || User whose appointments should be retrieved
|-
| companyId || integer || Yes || Company identifier for the appointments
|-
| startDate || string (date) || Yes* || Start of the date range (<code>Y-m-d</code>). Required by business logic even though format validation allows null
|-
| endDate || string (date) || Yes* || End of the date range (<code>Y-m-d</code>). Required by business logic even though format validation allows null
|-
| completed || integer || No || Appointment completion filter: <code>1</code> = completed (ended with Plus), <code>0</code> = not completed. Defaults to <code>0</code>
|}

=== Successful Response (200) ===
Returns matching appointments for the user and date range.

{| 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 || array || List of appointment records
|-
| uri || string || Requested resource URI
|}

==== data[] ====
{| class="wikitable"
! Field !! Type !! Description
|-
| appointment_id || integer || Unique identifier of the appointment
|-
| contact_id || integer || Contact associated with the appointment
|-
| name || string || Company name of the contact
|-
| latitude || number/string || Contact latitude
|-
| longitude || number/string || Contact longitude
|-
| created || string/datetime || Appointment created timestamp
|-
| start || string/datetime || Appointment start timestamp
|-
| notes || string || Appointment notes
|-
| duration || integer/number || Appointment duration
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation failed – response body uses <code>clientStatusCode</code> 422 with the first validation error message
|-
| 400 || Bad Request – appointments could not be retrieved
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''Validation (HTTP 200, clientStatusCode 422)''' – Missing/invalid <code>userId</code> or <code>companyId</code>, invalid date format, or invalid <code>completed</code> value.
* '''400''' – Missing required date parameters ("Invalid input parameters."), or no appointments found ("No appointments found.").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 15:34, 21 July 2026
Line 1:		Line 1:
−	== Fetch User Appointments ==	+	==[[Mobile_API]] » Fetch User Appointments ==

	=== Base URL ===		=== Base URL ===

Fetch User Appointment - Revision history

Ashley DeBon: /* Fetch User Appointments */

Ashley DeBon: Created page with "== Fetch User Appointments == === Base URL === https://apimobile.callproof.com === Endpoint === /api/ai/chat-bot/fetch-user-appointment === Purpose === Retrieves appointmen..."