Get Countries
Changed onReturns a JSON array of every country in the catalog, or a single country object when isoCode is supplied. Each element has id (Country ID), name (Country Name), and isoCode (ISO 3166-1 alpha-2 code or null when unset).
OAuth Scopes: field, meta
Request
- Base URLhttps://companySubDomain.bamboohr.com
- Auth
- HTTP basic
- or OAuth 2Authorization code/authorize.phpToken URL/token.phpScopesfield
- or OAuth 2Authorization code/authorize.phpToken URL/token.phpScopesmeta
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
ISO 3166-1 alpha-2 country code (exactly two letters). When present, returns the matching country as a single object instead of the full array.
Response
When isoCode is omitted: a JSON array of all country objects. When isoCode is provided: the matching country as a single object.
Changes
- breaking
the
/////response's property type changed fromintegertostringfor status - breaking
the
////response's property type changed fromintegertostringfor status - info
the security scope
fieldwas added to the endpoint's security schemeoauth - info
the security scope
metawas removed from the endpoint's security schemeoauth - info
the
/////response's property pattern^\d+$was added for the status - info
the
////response's property pattern^\d+$was added for the status
- breaking