Get Group
discourse.get_group
ActionBusiness appsconnection required
Calls the Discourse API with the connection's credentials.
Read one group by its name.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Discourse
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- base_url, api_username
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 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 |
|---|---|---|---|---|---|
name The group's name as it appears in the forum, not its numeric id. | string | Yes | — | — | support_team |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"name": "support_team"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
group The group record Discourse returned, in full. | object | — |
id The group's id. | number | — |
name The group's name. | string | — |
full_name The group's display name, empty when unset. | string | — |
user_count How many members the group has. | number | — |
automatic True for a group Discourse maintains itself, such as trust_level_1. | boolean | — |
{
"automatic": false,
"full_name": "",
"group": {},
"id": 0,
"name": "",
"user_count": 0
}Related Discourse nodes
See Get Group run in a workflow.
In a technical demo we add the Discourse connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.