Difference between revisions of "Parent Company List"
Ashley DeBon (talk | contribs) (→Parent Company Search) |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| Line 37: | Line 37: | ||
| parent_company_name || string || No || Search text matched against contact title (case-insensitive partial match). If empty or omitted, an empty list is returned | | parent_company_name || string || No || Search text matched against contact title (case-insensitive partial match). If empty or omitted, an empty list is returned | ||
|} | |} | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/parent-company-search' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "parent_company_name": "YOUR_SEARCH_TEXT" }' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/parent-company-search' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "parent_company_name": "YOUR_SEARCH_TEXT" }' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 11:55, 21 July 2026
Contents
Mobile_API »Parent Company Search
Base URL
https://apimobile.callproof.com
Endpoint
/api/parent-company-search
Purpose
Searches parent company titles within the authenticated user’s company. Returns distinct matching contacts by title for live parent-company selection.
HTTP Method
POST
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| parent_company_name | string | No | Search text matched against contact title (case-insensitive partial match). If empty or omitted, an empty list is returned |
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/parent-company-search' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "parent_company_name": "YOUR_SEARCH_TEXT" }'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/parent-company-search' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "parent_company_name": "YOUR_SEARCH_TEXT" }'
Successful Response (200)
Returns matching parent company titles for the user’s company.
| 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 matching parent company records |
| uri | string | Requested resource URI |
data[]
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier of the matching contact |
| title | string | Parent company / contact title |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – parent company search could not be completed |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while searching (for example, "Unfortunately, we’ve encountered an error and alerted CallProof.").
- 401 – Authentication failed or the access token is missing/expired.
