List Subreddits
reddit.list_subreddits
ActionChat & messagingconnection required
Calls the Reddit API with the connection's credentials.
List popular, new, default or premium subreddits.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}
- Config it needs
- user_agent, subreddit
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 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 |
|---|---|---|---|---|---|
where Which catalogue to read: popular, new, default or premium. | string | No | popular | one of "popular", "new", "default", "premium" | — |
limit How many items to return in one page. Reddit caps a page at 100. | number | No | 25 | 1–100 | — |
after Pagination cursor: the 'after' value returned by the previous page. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"limit": 25,
"where": "popular"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The things on this page, each unwrapped from its Listing child. | array | — |
count How many things this page returned. | number | — |
after Cursor for the next page, or null on the last page. | string | — |
before Cursor for the previous page, or null on the first page. | string | — |
{
"after": "",
"before": "",
"count": 0,
"items": []
}See List Subreddits run in a workflow.
In a technical demo we add the Reddit connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.