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

2026-07-20T14:57:35Z

‎Successful Response (200)

Ashley DeBon: /* Get Events List */

2026-07-20T14:55:55Z

‎Get Events List

Ashley DeBon: Created page with "== Get Events List == === Base URL === https://apimobile.callproof.com === Endpoint === /api/events === Purpose === Retrieves a paginated list of company events visible to..."

2026-07-20T14:55:25Z

Created page with "== Get Events List == === Base URL === https://apimobile.callproof.com === Endpoint === /api/events === Purpose === Retrieves a paginated list of company events visible to..."

New page

== Get Events List ==

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

=== Endpoint ===
/api/events

=== Purpose ===
Retrieves a paginated list of company events visible to the authenticated user. Visibility respects “just my events” / same-market user settings and excludes users who hide their events. Results are ordered by event start time (newest first) and can be filtered by sales rep or event type.

=== 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 ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| sales_rep_id || integer || No || Filter events to a specific sales rep / user
|-
| event_type_id || integer || No || Filter events by event type
|-
| page || integer || No || Page number for pagination (default: 1). Page size is 25
|}

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

=== Successful Response (200) ===
Returns a paginated list of events.

{| 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 event records (see below)
|-
| 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 events
|-
| uri || string || Requested resource URI
|}

==== data[] (key fields) ====
{| class="wikitable"
! Field !! Type !! Description
|-
| event_id || integer || Unique identifier of the event
|-
| event_type_id || integer || Event type identifier
|-
| event_type_name || string || Event type name
|-
| event_type_description || string || Event type description
|-
| event_type_image || string || Thumbnail image URL for the event user/type
|-
| event_user_id || integer || User who created/owns the event
|-
| event_user_name || string || Full name of that user
|-
| event_company_id || integer || Related company ID (0 when none)
|-
| event_company_name || string || Related company name
|-
| event_contact_id || integer || Related contact ID (0 when none)
|-
| event_contact_name || string || Related contact/company name
|-
| event_contact_people || string || Comma-separated people names linked via appointment/follow-up/event form
|-
| event_otheruser_id || integer || Other user ID, when applicable
|-
| event_otheruser_name || string || Other user name, when applicable
|-
| event_call_id || integer || Related call ID, when applicable
|-
| event_call_type || string || Call type name
|-
| event_call_phonenumber || string || Call phone number
|-
| event_badge_id || integer || Badge ID, when applicable
|-
| event_badge_name || string || Badge name
|-
| event_googleplace_id || integer || Google place ID, when applicable
|-
| event_googleplace_name || string || Place name
|-
| event_googleplace_address || string || Place address
|-
| event_googleplace_city || string || Place city
|-
| event_googleplace_latitude || string/number || Place latitude
|-
| event_googleplace_longitude || string/number || Place longitude
|-
| event_googleplace_distance || string/number || Place distance
|-
| event_appointment_id || integer || Related appointment ID, when applicable
|-
| event_appointment_notes || string || Appointment notes
|-
| event_appointment_latitude || string/number || Appointment latitude
|-
| event_appointment_longitude || string/number || Appointment longitude
|-
| event_appointment_duration || string/number || Appointment duration
|-
| event_follow_id || integer || Related follow-up/task ID, when applicable
|-
| event_follow_notes || string || Follow-up notes
|-
| event_contact_event_form_id || integer || Related contact event form submission ID
|-
| event_contact_event_form_name || string || Event form name
|-
| event_twilio_call_id || integer || Related Twilio call ID
|-
| event_twilio_call_status || string || Twilio call status
|-
| event_twilio_call_carrier_name || string || Carrier name
|-
| event_twilio_call_caller_name || string || Caller name
|-
| event_start || string || Event start date/time in the user’s timezone
|-
| event_start_date || string || Event start date portion
|-
| event_created || string || Event created date/time in the user’s timezone
|-
| event_created_date || string || Event created date portion
|-
| event_time_duration || string || Relative duration text derived from created time
|-
| event_message || string || Event message text
|-
| event_clickable_access || boolean || Whether the user can open/click through to the related contact
|}

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

* '''400''' – An error occurred while retrieving events (for example, "Error while retriving the Events List").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 14:55, 20 July 2026
Line 1:		Line 1:
−	== Get Events List ==	+	== [[Mobile_API]] »Get Events List ==

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

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

Get Events History FrontPage Details - Revision history

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

Ashley DeBon: /* Get Events List */

Ashley DeBon: Created page with "== Get Events List == === Base URL === https://apimobile.callproof.com === Endpoint === /api/events === Purpose === Retrieves a paginated list of company events visible to..."