Difference between revisions of "Get SalesCoach account based Event form details"
Ashley DeBon (talk | contribs) (Created page with "== Get Contact Event Forms (AI Chat Bot) == === Base URL === https://apimobile.callproof.com === Endpoint === /api/ai/chat-bot/contact/{id}/eventform === Purpose === Retrie...") |
Ashley DeBon (talk | contribs) (→Get Contact Event Forms (AI Chat Bot)) |
||
| Line 1: | Line 1: | ||
| − | == Get Contact Event Forms (AI Chat Bot) == | + | == [[Mobile_API]] »Get Contact Event Forms (AI Chat Bot) == |
=== Base URL === | === Base URL === | ||
Latest revision as of 15:57, 21 July 2026
Contents
Mobile_API »Get Contact Event Forms (AI Chat Bot)
Base URL
https://apimobile.callproof.com
Endpoint
/api/ai/chat-bot/contact/{id}/eventform
Purpose
Retrieves a paginated list of previously submitted event forms for a contact, for AI Chat Bot / Sales Coach flows. Results can optionally be filtered by event form name and are returned newest first.
HTTP Method
GET
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
| No | User email used to resolve which user’s event forms to load. If omitted, the authenticated user’s email is used |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | Yes | Unique identifier of the contact |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | No | Filters results by event form name (case-insensitive partial match) |
| page | integer | No | Page number for pagination (default: 1). Page size is 25 |
Request Body
None.
Successful Response (200)
Returns a paginated list of event form submissions for the contact.
| 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 | Event form list payload |
| firstItemOnPage | integer | Index of the first item on the current page |
| lastItemOnPage | integer | Index of the last item on the current page |
| hasNextPage | boolean | Whether a next page is available |
| hasPreviousPage | boolean | Whether a previous page is available |
| isFirstPage | boolean | Whether the current page is the first page |
| isLastPage | boolean | Whether the current page is the last page |
| next_page_url | string/null | URL of the next page, when available |
| prev_page_url | string/null | URL of the previous page, when available |
| first_page_url | string | URL of the first page |
| last_page_url | string | URL of the last page |
| pageCount | integer | Total number of pages |
| pageNumber | integer | Current page number |
| pageSize | integer | Number of items per page (25) |
| totalItemCount | integer | Total number of matching event form submissions |
| uri | string | Requested resource URI |
data.eventforms[]
| Field | Type | Description |
|---|---|---|
| Event_id | integer | Unique identifier of the contact event form submission |
| contact_id | integer | Contact identifier |
| company_name | string | Company name associated with the contact |
| company_address | string | Company address |
| company_state | string | Company state |
| company_city | string | Company city |
| company_zip | string | Company ZIP/postal code |
| event_form_id | integer | Event form definition identifier |
| points | integer/number | Points recorded for the submission |
| created | string/datetime | Original created timestamp |
| event_form_name | string | Event form name |
| event_position | integer | Event form position/order |
| event_points | integer/number | Points configured on the event form |
| submitted_by | string | Full name of the user who submitted the form |
| submitted_on | string | Submitted date/time in the user’s timezone (format: m-d-Y g:i A)
|
| submitted_on_date | string | Submitted date only (format: m-d-Y)
|
| People | string | Comma-separated names of people linked to the submission, or empty string when none |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – event forms could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – Invalid user email ("Invalid user email"), or another error retrieving event forms (for example, "No Records Found").
- 401 – Authentication failed or the access token is missing/expired.