Retrieve all users

GET /admin/users

Python

Default

from portkey_ai import Portkey

# Initialize the Portkey client
portkey = Portkey(
    api_key="PORTKEY_API_KEY",
)

# List users
users = portkey.admin.users.list()

print(users)

200

{
  "total": 2,
  "object": "list",
  "data": [
    {
      "object": "user",
      "id": "61e08f60-4822-465e-ba23-39f85cd741cb",
      "first_name": "horace",
      "last_name": "slughorn",
      "role": "member",
      "email": "[e-mail]",
      "created_at": "2024-01-25 11:35:07",
      "last_updated_at": "2024-01-25 11:35:07"
    }
  ]
}

Authorizations

x-portkey-api-key · string · header · required

Headers

x-portkey-api-key · string

Query Parameters

pageSize · integer

currentPage · integer

role · enum<string>

Available options: admin, member, owner

email · string<email>

Response

200 - application/json

OK

total · integer

Example:

2

object · enum<string>

Available options: list

data · object[]

Show child attributes