Get Current user Contact Type

From docs
Jump to: navigation, search

Retrieve Contact Types

Base URL

https://apimobile.callproof.com

Endpoint

/api/contact-type

Purpose

Returns the list of contact / account types available for the authenticated user’s company. Each type includes its name and whether it is the default type, so the client can display type options and pre-select the default when creating or editing a contact.

HTTP Method

GET

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

None.

Query Parameters

None.

Request Body

None.

cURL Example for Android

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

cURL Example for iOS

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

Successful Response (200)

Indicates that contact types for the authenticated user’s company were retrieved successfully.

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 Contact type payload
data.contact array Ordered list of contact / account types
data.contact[].id integer Unique contact type identifier
data.contact[].name string Contact type name
data.contact[].is_default boolean Whether this type is the default contact type for the company
uri string Requested resource URI

Error Responses

Status Code Meaning
400 Bad Request – contact types could not be retrieved successfully
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – The service encountered an error while retrieving contact types for the company.
  • 401 – Authentication failed or the access token is missing/expired.