Portkey Docs home page
Search or ask...
Sign in →
Support
Get Demo
Github
Sign in →
Search...
Navigation
Users
Retrieve all users
Documentation
Integrations
Inference API
Admin API
Cookbook
Changelog
Control Plane
Configs
Virtual Keys
API Keys
Analytics [BETA]
Users
GET
Retrieve a user
GET
Retrieve all users
PUT
Update a user
DEL
Remove a user
User Invites
Workspaces
Workspace Members
Data Plane
Feedback
Guardrails
Logs
OpenAPI Specification
Users
Retrieve all users
GET
/
admin
/
users
Send
Authorization
x-portkey-api-key
string
*
x-portkey-api-key
Required
string
Header
x-portkey-api-key
string
x-portkey-api-key
string
Query
pageSize
integer
pageSize
integer
currentPage
integer
currentPage
integer
role
enum<string>
Select option
role
enum<string>
email
string
email
string
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
Response
200 - application/json
total
integer
object
enum<string>
Available options:
list
data
object[]
Show child attributes
data.
object
enum<string>
Available options:
user
data.
id
string
data.
first_name
string
data.
last_name
string
data.
role
enum<string>
Available options:
admin
,
member
,
owner
data.
email
string
data.
created_at
string
data.
last_updated_at
string
data.
workspace_ids
string[]
Was this page helpful?
Yes
No
Retrieve a user
Update a user