Difference between revisions of "Retrieve the Contact Personnel Based on ContactId"

From docs
Jump to: navigation, search
(Created page with "== Retrieve Contact Personnel by Contact ID == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contacts/{id}/contact-personnel === Purpose === Return...")
 
(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}/contact-personnel' \
 +
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
 +
</pre>
 +
=== cURL Example for iOS ===
 +
<pre>
 +
curl --location 'https://apimobile.callproof.com/api/contacts/{id}/contact-personnel' \
 +
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
 +
</pre>
  
 
=== Successful Response (200) ===
 
=== Successful Response (200) ===

Latest revision as of 08:36, 17 July 2026

Retrieve Contact Personnel by Contact ID

Base URL

https://apimobile.callproof.com

Endpoint

/api/contacts/{id}/contact-personnel

Purpose

Returns the list of active people associated with a specific contact. Each person includes name, email, title, role, last contacted date, phone numbers, and image details so users can review the contact’s personnel from the contact profile.

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 whose personnel are requested

Query Parameters

None.

Request Body

None.

cURL Example for Android

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

cURL Example for iOS

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

Successful Response (200)

Indicates that contact personnel for the specified contact were retrieved successfully.

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 Contact personnel payload
data.contact_id integer Contact identifier
data.contact_company_name string Company / account name of the contact
data.contact_personnel array List of active people linked to the contact
data.contact_personnel[].id integer Unique personnel identifier
data.contact_personnel[].email string Personnel email address
data.contact_personnel[].name string Full name of the person
data.contact_personnel[].title string Job title
data.contact_personnel[].role_id integer People role identifier
data.contact_personnel[].role string People role name
data.contact_personnel[].last_contacted string Date the person was last contacted (format: MM-DD-YYYY), or empty if never contacted
data.contact_personnel[].phones array Phone numbers linked to the person
data.contact_personnel[].phones[].id integer Phone record identifier
data.contact_personnel[].phones[].phone_number string Formatted phone number
data.contact_personnel[].phones[].phone_type_id integer / string Phone type identifier
data.contact_personnel[].phones[].phone_type string Phone type name
data.contact_personnel[].phones[].extension string Phone extension
data.contact_personnel[].phones[].country_code string Country calling code
data.contact_personnel[].phones[].country_code_id integer / null Country code identifier
data.contact_personnel[].contact_personnel_image string Image URL for the person or related contact type
uri string Requested resource URI

Error Responses

Status Code Meaning
400 Bad Request – contact personnel could not be retrieved successfully
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – The service encountered an error while retrieving personnel for the specified contact, or the user profile is invalid.
  • 401 – Authentication failed or the access token is missing/expired.