Difference between revisions of "Get Label List For Specific Contact"
Ashley DeBon (talk | contribs) (Created page with "== Get Contact Labels == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/{id}/labels === Purpose === Retrieves the labels assigned to a speci...") |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| Line 41: | Line 41: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | <pre> | ||
| + | curl --location 'https://apimobile.callproof.com/api/contact/{id}/labels' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' | ||
| + | </pre> | ||
| + | === cURL Example for iOS === | ||
| + | <pre> | ||
| + | curl --location 'https://apimobile.callproof.com/api/contact/{id}/labels' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' | ||
| + | </pre> | ||
| + | |||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 12:42, 17 July 2026
Contents
Get Contact Labels
Base URL
https://apimobile.callproof.com
Endpoint
/api/contact/{id}/labels
Purpose
Retrieves the labels assigned to a specific contact. Results can optionally be filtered by label name.
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 |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | No | Filters assigned labels by a partial, case-insensitive name match |
Request Body
None.
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/contact/{id}/labels' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/contact/{id}/labels' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns the distinct labels assigned to the contact. Label names are returned in lowercase.
| 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 | Label payload |
| uri | string | Requested resource URI |
data.labels[]
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier of the label |
| name | string | Label name in lowercase |
| company_id | integer | Identifier of the company that owns the label |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – labels could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – Contact not found ("Contact Not Found"), or another error occurred while loading labels.
- 401 – Authentication failed or the access token is missing/expired.
