Difference between revisions of "EventForm With People"
Ashley DeBon (talk | contribs) (Created page with "== Get Event Form People List == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/{contact_id}/eventformpeople === Purpose === Retrieves the p...") |
Ashley DeBon (talk | contribs) (→Get Event Form People List) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == Get Event Form People List == | + | == [[Mobile_API]] »Get Event Form People List == |
=== Base URL === | === Base URL === | ||
| Line 37: | Line 37: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/contact/{contact_id}/eventformpeople' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/contact/{contact_id}/eventformpeople' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 07:11, 20 July 2026
Mobile_API »Get Event Form People List
Base URL
https://apimobile.callproof.com
Endpoint
/api/contact/{contact_id}/eventformpeople
Purpose
Retrieves the people (personnel) associated with a contact for use when filling out or selecting people on an event form. Results are ordered by first name.
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
None.
Request Body
None.
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/contact/{contact_id}/eventformpeople' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/contact/{contact_id}/eventformpeople' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns the people linked to 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 people for the contact |
| uri | string | Requested resource URI |
data[]
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier of the person |
| full_name | string | Full name (first name + last name) |
| first_name | string | First name |
| last_name | string | Last name |
| title | string | Job title |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – people list could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while retrieving people (for example, "Error while retriving the People list").
- 401 – Authentication failed or the access token is missing/expired.
