Country Details

From docs
Revision as of 15:39, 20 July 2026 by Ashley DeBon (talk | contribs) (Successful Response (200))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Mobile_API »Get Countries

Base URL

https://apimobile.callproof.com

Endpoint

/api/country

Purpose

Retrieves the list of countries available in the system. The United States is returned first, followed by all other countries.

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/country' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

cURL Example for iOS

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

Successful Response (200)

Returns the country list.

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 Country list payload
uri string Requested resource URI

data.country[]

Field Type Description
id integer Unique identifier of the country
name string Country name

Error Responses

Status Code Meaning
400 Bad Request – countries could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – An error occurred while retrieving the country list (for example, "Error while retriving the Country List").
  • 401 – Authentication failed or the access token is missing/expired.