Skip to content

Deel: Retrieve Country List

Deel lookups.getCountries: arguments, response, policy and SDK examples.

← Lookups operations · Get started

Operation deel.lookups_getcountries

Provider route: GET /lookups/countries. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["lookups"]["getCountries"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.lookups.getCountries(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.lookups.get_countries(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve Country List — 200 response body

Referenced models: Retrieve Country List — 200 response body

Retrieve Country List — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Retrieve Country List — 200 response body — data item

Referenced models: Retrieve Country List — 200 response body — data item

Retrieve Country List — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
codestringRequired within parentThe ISO 3166-1 alpha-2 country code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
default_currencystringRequired within parentIndicates the default currency 3-letter ISO code
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
eor_supportbooleanRequired within parentIndicates whether Deel provides Employer of Record (EoR) support in this country.
namestringRequired within parentThe official name of the country.
Minimum length: 1
state_typeJSONRequired within parent
state_type (anyOf 1)stringAlternativeThe designation for sub-territories within the country, such as 'state', 'province', 'prefecture', or 'region'. If none, this field will be null.
state_type (anyOf 2)nullAlternativeThe designation for sub-territories within the country, such as 'state', 'province', 'prefecture', or 'region'. If none, this field will be null.
statesarrayRequired within parentList of sub-territories within the country. These may be called states, provinces, prefectures, regions, or may not exist.
states[]ModelEach itemExpand Retrieve Country List — 200 response body — data item states item
visa_supportbooleanRequired within parentIndicates whether Deel provides visa support for employees being hired in this country.

Referenced models: Retrieve Country List — 200 response body — data item states item

Retrieve Country List — 200 response body — data item states item
FieldTypePresenceDescription and constraints
$objectRoot
codestringRequired within parentThe code representing the sub-territory (e.g., state or region).
Minimum length: 1
namestringRequired within parentThe name of the sub-territory (e.g., state or region).
Minimum length: 1

SDK function policy ID: deel.lookups_getcountries. Catalog operation: lookups/countries. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.