List users with the PagerDuty API

Lists the users of the account, with id, name, email and role. The id goes in the assignee of Create incident and Update incident. Page with limit and offset while more is true.

Identifier
pagerduty_list_users

The request

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "query": "<query>"
  }
}

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
querystringNoReturns only the users whose name or email matches this text.
limitintegerNoUsers per page, up to 100.
offsetintegerNoNumber of users to skip.
totalbooleanNoSet to true to fill the total field of the response, which is slower.

Supported connections

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

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

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/pagerduty_list_users. It becomes your agent's tool definition with no conversion.

Other PagerDuty 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.