Skip to content
General Augment Docs

List Users

GET
/api/v1/admin/projects/{project_id}/users

List users for a project with activity counters.

Parameters

Section titled “ Parameters ”

Path Parameters

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

Query Parameters

Section titled “Query Parameters ”
page
Page
integer
default: 1 >= 1
page_size
Page Size
integer
default: 50 >= 1 <= 500

Header Parameters

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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

PaginatedResponse[AdminUserListItem]
object
items
required
Items
Array<object>
AdminUserListItem

Admin list view for a user with activity counters.

object
display_name
required
Any of:
string
id
required
Id
string format: uuid
last_active_at
required
Any of:
string format: date-time
message_count
required
Message Count
integer
phone_e164
required
Phone E164
string
page
required
Page
integer
>= 1
page_size
required
Page Size
integer
>= 1 <= 500
total
required
Total
integer

422

Section titled “422 ”

Validation Error

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