Difference between revisions of "Retrieve the Contact Info Email Based on ContactId"
Ashley DeBon (talk | contribs) (Created page with "== Get Contact Info Email == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contacts/{id}/info-email === Purpose === Retrieves all email addresses a...") |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| Line 37: | Line 37: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | <pre> | ||
| + | curl --location 'https://apimobile.callproof.com/api/contacts/{id}/info-email' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' | ||
| + | </pre> | ||
| + | === cURL Example for iOS === | ||
| + | <pre> | ||
| + | curl --location 'https://apimobile.callproof.com/api/contacts/{id}/info-email' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' | ||
| + | </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 10:58, 17 July 2026
Contents
Get Contact Info Email
Base URL
https://apimobile.callproof.com
Endpoint
/api/contacts/{id}/info-email
Purpose
Retrieves all email addresses associated with a contact, grouped into company-level emails (primary contact email plus any additional company emails) and personnel-level emails for people linked to that contact.
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 |
|---|---|---|---|
| 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/contacts/{id}/info-email' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/contacts/{id}/info-email' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns company and personnel email lists 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 | Email payload (see below) |
| uri | string | Requested resource URI |
data
| Field | Type | Description |
|---|---|---|
| company_emails | array | Company-level emails (primary contact email listed first when present, followed by additional company emails) |
| personnel_emails | array | Email addresses for people (personnel) linked to the contact |
data.company_emails[]
| Field | Type | Description |
|---|---|---|
| email_id | integer | Unique identifier of the email record |
| email_value | string | Email address |
| contact_type | integer | Contact type identifier (included on the primary contact email; defaults to 0 for additional company emails) |
data.personnel_emails[]
| Field | Type | Description |
|---|---|---|
| personnel_id | integer | Unique identifier of the person |
| email_value | string | Email address for that person |
| personnel_name | string | Full name of the person |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – email information could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while loading contact email details.
- 401 – Authentication failed or the access token is missing/expired.
