v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Country

Search Countries

Search a list of Countries.

get/utilities/countries/search

Query parameters

qstring required

Search query. See the Search section for guidance on how to build a query.

pageinteger

Specifies the page of records to be returned. Defaults to 1.

page_sizeinteger

Number of records to return per page. Maximum and default are 100 records.

sortstring

Specifies the order in which the list will be returned. Default order is ascending. Default sort attribute is Id. Specify desc_ to sort descending format: "sort=desc_snake_cased_attribute_name" OR "sort=snake_cased_attribute_name" ex. sort=desc_updated_on

Headers

x-api-keystring required

A valid api key. If you don't have one, please request one through the Web Integration screen.

Response

countries