List rooms with the Webex API

Lists the spaces the user is in, with id and title; in a 1:1 space the title is the other person. Webex pages with a Link header that this connection does not return, so ask for up to 1000 spaces at once with max.

Identifier
webex_list_rooms

The request

POST https://connect.reportei.com/api/tools/webex_list_rooms/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "type": "direct"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
typestringNodirect for 1:1 spaces, group for group spaces.Values: direct, group
sortBystringNoOrder of the spaces. lastactivity puts the most recently active first.Values: id, lastactivity, created
maxintegerNoSpaces in the response, up to 1000.

Supported connections

Your customer connects their Webex account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/webex, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/webex_list_rooms. It becomes your agent's tool definition with no conversion.

Other Webex tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.