Skip to content
General Augment Docs

List Users

GET
/api/v3/projects/{project_id}/users
curl --request GET \
  --url 'https://example.com/api/v3/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/users?limit=50'

List stable app-user identities without loading memory or runs.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project_id
required
Project Id
string format: uuid

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 50 >= 1 <= 100
cursor
Any of:
string format: uuid

Header Parameters

Section titled “Header Parameters”
X-Admin-Key
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
UserPageV3
object
items
Items
Array<object>
UserResponseV3
object
created_at
required
Created At
string format: date-time
display_name
Any of:
string
external_provider
Any of:
string
external_user_id
Any of:
string
id
required
Id
string format: uuid
last_active_at
Any of:
string format: date-time
preferred_channel
required
Preferred Channel
string
project_id
required
Project Id
string format: uuid
status
required
Status
string
next_cursor
Any of:
string format: uuid
Examplegenerated
{
  "items": [
    {
      "created_at": "2026-04-15T12:00:00Z",
      "display_name": "example",
      "external_provider": "example",
      "external_user_id": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "last_active_at": "2026-04-15T12:00:00Z",
      "preferred_channel": "example",
      "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "status": "example"
    }
  ],
  "next_cursor": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}