EventForm Previous List With Searching

From docs
Jump to: navigation, search

Mobile_API »Get Previous Event Forms

Base URL

https://apimobile.callproof.com

Endpoint

/api/contact/{contact_id}/eventform

Purpose

Retrieves a paginated list of previously submitted event forms for a contact. 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

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter Type Required Description
contact_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.

cURL Example for Android

 curl --location 'https://apimobile.callproof.com/api/contact/{contact_id}/eventform' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

cURL Example for iOS

 curl --location 'https://apimobile.callproof.com/api/contact/{contact_id}/eventform' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Successful Response (200)

Returns a paginated list of previously submitted event forms 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 array List of event form submissions (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 event form submissions
uri string Requested resource URI

data[]

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 – previous event forms could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – An error occurred while retrieving event forms (for example, "No Records Found").
  • 401 – Authentication failed or the access token is missing/expired.
Retrieved from "http://docs.callproof.com/index.php?title=EventForm_Previous_List_With_Searching&oldid=2401"