users
Scout API 1.0.0 — see schemas for shared types.
GET /api/users
query_users
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
query |
query | string | no |
Responses
- 200 — OK
application/json→ UserResponseList- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/users/connected-services
get_user_connected_services
Responses
- 200 — OK
application/json→ ConnectedServicesResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/users/costs
get_user_costs
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
from_date |
query | string (date-time) | null | no | |
to_date |
query | string (date-time) | null | no | |
user_ids |
query | array\<string (uuid)> | null | no | |
model |
query | string | null | no | |
group_by_tenant |
query | boolean | null | no | |
include_only_billable |
query | boolean | null | no |
Responses
- 200 — OK
application/json→ GetCostsResponseModel- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/users/custom-prompt
get_user_custom_prompt
Responses
- 200 — OK
application/json→ UserCustomPromptResponse- 422 — Unprocessable Content
application/json→ ValidationError
PUT /api/users/custom-prompt
update_user_custom_prompt
Request body
Content-Type: application/json
Schema: UpdateUserCustomPromptBody
Responses
- 200 — OK
application/json→ UserCustomPromptResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/users/external-services
get_external_services
Responses
- 200 — OK
application/json→ ExternalServicesWithStatusResponse- 422 — Unprocessable Content
application/json→ ValidationError
POST /api/users/logout
logout
Request body
Content-Type: application/json
Schema: LogoutRequest
Responses
- 200 — OK
application/json→ LogoutResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/users/me
get_current_user
Responses
- 200 — OK
application/json→ CurrentUserResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/users/me/teams
list_my_teams
Responses
- 200 — OK
application/json→ UserTeamResponseList- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/users/preferences
get_user_preferences
Responses
- 200 — OK
application/json→ UserPreferencesResponse- 422 — Unprocessable Content
application/json→ ValidationError
PATCH /api/users/preferences
update_user_preferences
Request body
Content-Type: application/json
Schema: UpdateUserPreferencesBody
Responses
- 200 — OK
application/json→ UserPreferencesResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/users/stats
get_user_stats
Responses
- 200 — OK
application/json→ UserStatsResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/users/usage
get_user_usage
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
month |
query | string | null | no | |
include_only_billable |
query | boolean | null | no |
Responses
- 200 — OK
application/json→ UserUsageResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/users/usage-detail
get_user_usage_detail
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
month |
query | string | yes |
Responses
- 200 — OK
application/json→ ControlTowerUserUsageResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/users/usage-summary
get_user_usage_summary
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
include_only_billable |
query | boolean | null | no |
Responses
- 200 — OK
application/json→ UsageSummaryResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/users/usage/first-month
get_user_first_usage_month
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
include_only_billable |
query | boolean | null | no |
Responses
- 200 — OK
application/json→ UserFirstUsageMonthResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/users/{user_id}
get_user
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
user_id |
path | string (uuid) | yes |
Responses
- 200 — OK
application/json→ UserResponse- 422 — Unprocessable Content
application/json→ ValidationError