Difference between revisions of "Get Images List For Specific Contact"
Ashley DeBon (talk | contribs) (Created page with "== Get Contact Images == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/{id}/images === Purpose === Retrieves the list of images uploaded fo...") |
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/contact/{id}/images' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' | ||
| + | </pre> | ||
| + | === cURL Example for iOS === | ||
| + | <pre> | ||
| + | curl --location 'https://apimobile.callproof.com/api/contact/{id}/images' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' | ||
| + | </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 11:55, 17 July 2026
Contents
Get Contact Images
Base URL
https://apimobile.callproof.com
Endpoint
/api/contact/{id}/images
Purpose
Retrieves the list of images uploaded for a specific contact by the authenticated user. Each image includes its display path, size metadata, source details when linked to an event form/custom field, and created date.
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/contact/{id}/images' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/contact/{id}/images' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns images for the contact and authenticated user.
| 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 | Image payload |
| uri | string | Requested resource URI |
data.contact_images[]
| Field | Type | Description |
|---|---|---|
| image_id | integer | Unique identifier of the image |
| contact_name | string | Contact/company display name |
| image_path | string | Full image URL/path |
| image_height | integer | Image display height; currently configured as 480
|
| image_width | integer | Image display width; currently configured as 480
|
| event_form | string | Event form name linked to the image, when available |
| custom_field | string | Custom field name linked to the image, when available |
| default | integer | Default image flag used by the API |
| created | string | Created date/time in the user’s timezone, formatted as m-d-Y g:i A
|
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – images could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while loading contact images.
- 401 – Authentication failed or the access token is missing/expired.
