Difference between revisions of "View Business Card details"
Ashley DeBon (talk | contribs) (Created page with "== Get Business Card By ID == === Base URL === https://apimobile.callproof.com === Endpoint === /api/business-card/{id} === Purpose === Retrieves a single business card by...") |
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/business-card/{id}' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' | ||
| + | </pre> | ||
| + | === cURL Example for iOS === | ||
| + | <pre> | ||
| + | curl --location 'https://apimobile.callproof.com/api/business-card/{id}' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' | ||
| + | </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 14:30, 17 July 2026
Contents
Get Business Card By ID
Base URL
https://apimobile.callproof.com
Endpoint
/api/business-card/{id}
Purpose
Retrieves a single business card by ID for the authenticated user and company, including front/back image URLs when available.
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 business card to retrieve |
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/business-card/{id}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/business-card/{id}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns the requested business card details.
| 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 | Business card payload |
| uri | string | Requested resource URI |
data.business_card_details
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier of the business card |
| contact_id | integer | Linked contact ID, when available (otherwise 0) |
| contact_personnel_id | integer | Linked personnel ID, when available (otherwise 0) |
| first_name | string | First name on the card |
| last_name | string | Last name on the card |
| title | string | Job title on the card |
| company_name | string | Company name on the card |
| address | string | Address on the card |
| website | string | Website on the card |
| string | Email on the card | |
| phone_number | string | Phone number on the card |
| notes | string | Notes on the card |
| business_card_image | string | URL for the front image, when available |
| business_card_back_image | string | URL for the back image, when available |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – the business card could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – No matching card found for the user/company ("No Records Found"), or another retrieval error.
- 401 – Authentication failed or the access token is missing/expired.
