List Locales
contentful.list_locales
ActionBusiness appsconnection required
Calls the Contentful API with the connection's credentials.
List the locales an environment publishes content in.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Contentful
- Secret shape
- the CMA access token, or {"access_token": "…"}
- Config it needs
- space_id, environment_id, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
limit How many items to return in one page (1-1000); Contentful defaults to 100. | number | No | — | 1–1000 | — |
skip How many items to skip before this page starts, so pages can be walked. | number | No | — | ≥ 0 | — |
space_id The space to act on. Leave blank to use the connection's space. | string | No | — | — | — |
environment_id The environment to act on. Leave blank to use the connection's environment, or 'master'. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The page of entities Contentful returned. | array | — |
count How many entities are in this page. | number | — |
total How many entities match in total, across all pages. | number | — |
skip How many entities were skipped before this page. | number | — |
limit The page size Contentful applied. | number | — |
space_id The space the page was read from. | string | — |
environment_id The environment the page was read from. | string | — |
{
"count": 0,
"environment_id": "",
"items": [],
"limit": 0,
"skip": 0,
"space_id": "",
"total": 0
}See List Locales run in a workflow.
In a technical demo we add the Contentful connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.