getCountries

Returns a paged list of countries.

getCountries

Overview

This method returns a list of countries, optionally filtered by name or ISO code. The country_id can be used on other records, for example a contact's country_id.

This method requires the Countries:Get permission to be associated with your role.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'Countries:Get'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/gb/countries?iso_code_2=AU 
https://api.{{environment}}.catch-e.com/gb/countries?iso_code_2=AU https://api.test.catch-e.com/gb/countries?iso_code_2=AU

Query Parameters

Key	Format	Notes	Mandatory
name	string	Filter by country name. Up to 100 characters; letters, spaces, apostrophes, hyphens, brackets, full stops and commas. Supports the wildcard `%` operator.	No
iso_code_2	string	Filter by ISO 3166-1 alpha-2 code. Up to 2 letters. Supports the wildcard `%` operator.	No
iso_code_3	string	Filter by ISO 3166-1 alpha-3 code. Up to 3 letters. Supports the wildcard `%` operator.	No
page	integer	Page number. Default `1`.	No
page_size	integer	Number of records per page. Default `25`. Use `-1` to return all records.	No

Response Details

Success

200 - OK

Each record in _embedded.gb_countries contains:

Field	Format	Notes
country_id	string	Country Id.
name	string	Country name.
iso_code_2	string	ISO 3166-1 alpha-2 code.
iso_code_3	string	ISO 3166-1 alpha-3 code.

{ "_links": { "self": { "href": "https://api.catch-e.loc/gb/countries?iso_code_2=AU&page=1" } }, "_embedded": { "gb_countries": [ { "country_id": "1", "name": "Australia", "iso_code_2": "AU", "iso_code_3": "AUS" } ] }, "page_count": 1, "page_size": 25, "total_items": 1, "page": 1 }

Error Response Details

Validation Message	Comments
401 - Unauthorized	1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Validation Message	Comments
403 - Forbidden	- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

Validation Message	Comments
404 - Not Found	No countries were found.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Found", "status": 404, "detail": "Not Found" }

Validation Message	Comments
406 - Not Acceptable	The Accept header of the request does not match a response format this API supports.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

Validation Message	Comments
409 - Conflict	The request conflicts with the current state of the data.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Conflict", "status": 409, "detail": "Conflict" }

Validation Message	Comments
422 - Unprocessable Entity	One or more input fields failed validation. The field name and message are returned in `validation_messages`.

{ "warning_messages": {}, "validation_messages": { "fieldName": { "validationExceptionCode": "A textual description of the validation exception" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Validation Message	Comments
default - Unexpected Error	Any other unexpected error.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }