List People
webex.list_people
ActionChat & messagingconnection required
Calls the Cisco Webex API with the connection's credentials.
Look someone up in Webex by email or display name.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Cisco Webex
- Secret shape
- the Webex access token, or {"access_token": "…"}
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 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 |
|---|---|---|---|---|---|
email Find the person with this email address. | string | No | — | email format | john.andersen@example.com |
display_name Find people whose display name starts with this. | string | No | — | — | — |
person_id Find people by a comma-separated list of person ids. | string | No | — | — | — |
org_id Only people in this organisation. Administrators only. | string | No | — | — | — |
roles Only people with these role ids, comma-separated. Administrators only. | string | No | — | — | — |
location_id Only people at this location. Administrators only. | string | No | — | — | — |
max_results How many people to ask for. Webex caps it at 50 when location_id is set. | number | No | 100 | ≥ 1 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"email": "john.andersen@example.com",
"max_results": 100
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items[].id The person id — pass it to webex.create_membership. | string | — |
items[].emails The person's email addresses; the first is the primary one. | array | — |
items[].display_name The person's display name. | string | — |
items[].first_name The person's first name. | string | — |
items[].last_name The person's last name. | string | — |
items[].avatar URL of the person's avatar image. | string | — |
items[].org_id Id of the person's organisation. | string | — |
items[].type 'person', 'bot' or 'appuser'. | string | — |
items[].status Presence, e.g. active, meeting, DoNotDisturb — when shared. | string | — |
items[].timezone The person's timezone, e.g. America/Denver. | string | — |
items[].last_activity When they were last active (ISO-8601). | string | — |
items[].created When the account was created (ISO-8601). | string | — |
count How many rows this page carries. | number | — |
{
"count": 0,
"items": [
{
"avatar": "",
"created": "",
"display_name": "",
"emails": [],
"first_name": "",
"id": "",
"last_activity": "",
"last_name": "",
"org_id": "",
"status": "",
"timezone": "",
"type": ""
}
]
}Notes
- Webex requires email or display_name for anyone who is not an organisation administrator; an admin may list without a filter.
- Polling this call for presence hits the rate limit quickly — Webex says so in its own docs.
- One page only: Webex paginates with an RFC 5988 Link header, which this node does not follow — narrow the filters or raise max_results instead.
See List People run in a workflow.
In a technical demo we add the Cisco Webex connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.