Ashley DeBon: /* Get Event Form Add Details */

2026-07-20T07:23:59Z

‎Get Event Form Add Details

Ashley DeBon: Created page with "== Get Event Form Add Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/{contact_id}/eventform/{event_form_id} === Purpose === Retri..."

2026-07-20T07:19:49Z

Created page with "== Get Event Form Add Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/{contact_id}/eventform/{event_form_id} === Purpose === Retri..."

New page

== Get Event Form Add Details ==

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

=== Endpoint ===
/api/contact/{contact_id}/eventform/{event_form_id}

=== Purpose ===
Retrieves the data needed to start filling out a specific event form for a contact. The response includes contact summary details, basic event form info, and the form’s custom/regular fields (with options and prefilled values when configured).

=== HTTP Method ===
GET

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| contact_id || integer || Yes || Unique identifier of the contact
|-
| event_form_id || integer || Yes || Unique identifier of the event form to load
|}

==== Query Parameters ====
None.

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

=== Successful Response (200) ===
Returns contact details, event form info, and field definitions for creating a new submission.

{| 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 || object || Event form add payload
|-
| uri || string || Requested resource URI
|}

==== data.contact_details ====
{| class="wikitable"
! Field !! Type !! Description
|-
| contact_id || integer || Contact identifier
|-
| account_type || string || Contact type name
|-
| account_type_id || integer || Contact type identifier
|-
| account_number || string || Account number
|-
| company_name || string || Company name
|-
| parent_company || string || Parent company / title
|-
| address1 || string || Address line 1
|-
| address2 || string || Address line 2
|-
| city || string || City
|-
| state || string || State abbreviation
|-
| state_id || integer || State identifier
|-
| zipcode || string || ZIP/postal code
|-
| country || string || Country name
|-
| country_id || integer || Country identifier
|-
| company_email || string || Contact email
|-
| phone || string || Formatted phone number
|-
| phone_type_id || integer || Phone type identifier
|-
| country_code || string || Phone country/dialing code
|-
| website || string || Website
|}

==== data.eventform_info ====
{| class="wikitable"
! Field !! Type !! Description
|-
| event_form_id || integer || Contact event form submission ID (0 for a new add)
|-
| event_form_name || string || Event form display name
|-
| event_form_created_date || string || Created date for a new add (empty string)
|}

==== data.custom_fields[] ====
{| class="wikitable"
! Field !! Type !! Description
|-
| name || string || Field display name
|-
| position || integer || Field display order
|-
| points || integer/number || Field points value
|-
| required || boolean || Whether the field is required
|-
| custom_field_id || integer || Custom field identifier
|-
| custom_field_inner_id || integer || Related/inner custom field identifier
|-
| custom_field_regular_id || integer || Regular field identifier (0 when not a regular field)
|-
| custom_field_type_id || integer || Field type identifier
|-
| custom_field_type || object/array || Field type details
|-
| custom_field_option || array || Available options for select/radio-style fields
|-
| custom_field_table_id || integer || Custom field table identifier
|-
| custom_field_option_default_id || string || Default/selected option identifier when prefilled
|-
| value || string || Prefill value for the field, when available
|}

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

* '''400''' – An error occurred while loading form details (for example, "Error while retriving the Event form prefill Details").
* '''401''' – Authentication failed or the access token is missing/expired.

If you meant the next route after this (`contact/eventformscheduletask`), say so and I’ll document that one.

← Older revision		Revision as of 07:23, 20 July 2026
Line 1:		Line 1:
−	== Get Event Form Add Details ==	+	== [[Mobile_API]] »Get Event Form Add Details ==

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

EventForm Add Process Get Details - Revision history

Ashley DeBon: /* Get Event Form Add Details */

Ashley DeBon: Created page with "== Get Event Form Add Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/{contact_id}/eventform/{event_form_id} === Purpose === Retri..."