PIpipedream

List users

Retrieve all external users for the project

get/v1/connect/{project_id}/users

Request

  • Base URL
    https://api.pipedream.com
  • URL
    https://api.pipedream.com/v1/connect/{project_id}/users
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.pipedream.com/v1/oauth/token scopes: connect:users:read

Query parameters

afterstring

The cursor to start from for pagination

beforestring

The cursor to end before for pagination

limitinteger

The maximum number of results to return

qstring

Filter users by external_id (partial match)

Headers

x-pd-environment'development' | 'production' required

The environment in which the server client is running

Response

users listed

Example response

{
  "data": [
    {
      "id": "exu_abc123"
    }
  ],
  "page_info": {
    "count": 10,
    "total_count": 120
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.