Ashley DeBon: /* Get Event Form Count */

2026-07-21T15:47:00Z

‎Get Event Form Count

Ashley DeBon: Created page with "== Get Event Form Count == === Base URL === https://apimobile.callproof.com === Endpoint === /api/ai/chat-bot/get-event-form-count === Purpose === Returns how many event fo..."

2026-07-21T15:46:37Z

Created page with "== Get Event Form Count == === Base URL === https://apimobile.callproof.com === Endpoint === /api/ai/chat-bot/get-event-form-count === Purpose === Returns how many event fo..."

New page

== Get Event Form Count ==

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

=== Endpoint ===
/api/ai/chat-bot/get-event-form-count

=== Purpose ===
Returns how many event forms were submitted for one or more users in a company within a date range. Used by the AI chat bot for event-form submission count questions.

=== 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 or array of integers || Yes || User ID(s) whose event form submissions should be counted
|-
| companyId || integer || Yes || Company identifier used to scope the count
|-
| startDate || string || Yes || Start date in <code>Y-m-d</code> format
|-
| endDate || string || Yes || End date in <code>Y-m-d</code> format
|}

=== Successful Response (200) ===
Returns the total number of matching event form submissions.

{| 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 || integer || Count of event form submissions in the date range for the given user(s) and company
|-
| uri || string || Requested resource URI
|}

=== 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 – event form count could not be retrieved
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''Validation (HTTP 200, clientStatusCode 422)''' – Missing/invalid <code>userId</code>, <code>companyId</code>, or dates not in <code>Y-m-d</code> format.
* '''400''' – Failed to fetch event form count, or invalid/missing parameters.
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 15:47, 21 July 2026
Line 1:		Line 1:
−	== Get Event Form Count ==	+	== [[Mobile_API]] »Get Event Form Count ==

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

Get Event Form Count - Revision history

Ashley DeBon: /* Get Event Form Count */

Ashley DeBon: Created page with "== Get Event Form Count == === Base URL === https://apimobile.callproof.com === Endpoint === /api/ai/chat-bot/get-event-form-count === Purpose === Returns how many event fo..."