Get Contact Parent Company Detail

From docs
Jump to: navigation, search

Get Contact Parent Company

Base URL

https://apimobile.callproof.com

Endpoint

/api/contact/parent-company

Purpose

Searches contacts in the authenticated user’s company by title and returns matching parent-company style results. Results are ordered alphabetically by title and limited to 20 records.

HTTP Method

GET

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

None.

Query Parameters

Parameter Type Required Description
title string No Partial title text used to search contacts (case-insensitive). If omitted/empty, matching is unrestricted within the result limit

Request Body

None.

cURL Example for Android

curl --location 'https://apimobile.callproof.com/api/contact/parent-company' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

cURL Example for iOS

curl --location 'https://apimobile.callproof.com/api/contact/parent-company' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Successful Response (200)

Returns matching contact title records for parent-company selection.

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 Parent company search payload
uri string Requested resource URI

data.parent_company_detail[]

Field Type Description
id integer Unique identifier of the contact
title string Contact title

Error Responses

Status Code Meaning
400 Bad Request – parent company details could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – An error occurred while searching parent company contacts.
  • 401 – Authentication failed or the access token is missing/expired.