List of Business card details

Mobile_API »Get Business Cards

Base URL

https://apimobile.callproof.com

Endpoint

/api/business-cards

Purpose

Retrieves a paginated list of business cards for the authenticated user and company. Cards marked deleted from the scanner are excluded. Results can optionally be filtered by a search term across company name, first name, last name, and phone number.

HTTP Method

POST

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
page	integer	No	Page number for pagination (default: 1). Page size is 10

Request Body

Parameter	Type	Required	Description
search	string	No	Search text applied to company name, first name, last name, and phone number
page	integer	No	Page number for pagination (can also be sent as a query parameter)

cURL Example for Android

curl --location --request POST 'https://apimobile.callproof.com/api/add-business-card' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--form 'business_card_image=@/path/to/front.jpg'

cURL Example for iOS

curl --location --request POST 'https://apimobile.callproof.com/api/add-business-card' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--form 'business_card_image=@/path/to/front.jpg'

Successful Response (200)

Returns a paginated list of business cards.

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 list payload
firstItemOnPage	integer	Index of the first item on the current page
lastItemOnPage	integer	Index of the last item on the current page
hasNextPage	boolean	Whether a next page is available
hasPreviousPage	boolean	Whether a previous page is available
isFirstPage	boolean	Whether the current page is the first page
isLastPage	boolean	Whether the current page is the last page
next_page_url	string/null	URL of the next page, when available
prev_page_url	string/null	URL of the previous page, when available
first_page_url	string	URL of the first page
last_page_url	string	URL of the last page
pageCount	integer	Total number of pages
pageNumber	integer	Current page number
pageSize	integer	Number of items per page (10)
totalItemCount	integer	Total number of matching business cards
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
email	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 – business cards could not be retrieved
401	Unauthorized – missing, invalid, or expired Bearer token

• 400 – An error occurred while loading the business card list.
• 401 – Authentication failed or the access token is missing/expired.