Users
User management — invite, list, update roles, disable/re-enable.
Returns all users. Requires owner or admin role.
Authorization
bearer_auth In: header
Query Parameters
Search users
Sort field
Sort direction
Page size
int64Page offset
int64Response Body
application/json
application/json
curl -X GET "https://example.com/v1/users"{ "total": 0, "users": [ { "avatar_url": "string", "created_at": 0, "display_name": "string", "email": "string", "id": "string", "role": "owner", "status": "active", "updated_at": 0 } ]}Creates a new user with invited status. Requires owner or admin role.
Authorization
bearer_auth In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/users/invite" \ -H "Content-Type: application/json" \ -d '{ "email": "string", "role": "string" }'{ "user": { "avatar_url": "string", "created_at": 0, "display_name": "string", "email": "string", "id": "string", "role": "owner", "status": "active", "updated_at": 0 }}Returns the profile of the currently authenticated user.
Authorization
bearer_auth In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/users/me"{ "user": { "avatar_url": "string", "created_at": 0, "display_name": "string", "email": "string", "id": "string", "role": "owner", "status": "active", "updated_at": 0 }}curl -X GET "https://example.com/v1/users/me/digest"{ "apps": [ { "builds": 0, "failed": 0, "name": "string", "project_id": "string", "releases": [ { "state": "string", "store": "string", "track": "string", "version": "string" } ], "slowest_pipeline": null, "succeeded": 0 } ], "expiring": [ { "expires_at": 0, "name": "string", "project_name": "string" } ], "period_end": 0, "period_start": 0}curl -X POST "https://example.com/v1/users/me/digest/send"Approvals I can give, my failed builds and release changes of apps I pinned, from the last 7 days.
Authorization
bearer_auth In: header
Response Body
application/json
curl -X GET "https://example.com/v1/users/me/inbox"{ "items": [ { "at": 0, "build_id": "string", "detail": "string", "id": "string", "kind": "approval", "project_id": "string", "project_name": "string", "release_id": "string", "title": "string" } ]}curl -X GET "https://example.com/v1/users/me/notification-preferences"{ "email_address": "string", "email_available": true, "preferences": { "approvals": true, "browser": true, "email": true, "followed_releases": true, "my_builds": "off", "weekly_digest": true }}Authorization
bearer_auth In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
One person's notification choices. Instance channels are unaffected.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v1/users/me/notification-preferences" \ -H "Content-Type: application/json" \ -d '{ "approvals": true, "browser": true, "email": true, "followed_releases": true, "my_builds": "off", "weekly_digest": true }'{ "email_address": "string", "email_available": true, "preferences": { "approvals": true, "browser": true, "email": true, "followed_releases": true, "my_builds": "off", "weekly_digest": true }}Soft-deletes a user. Requires owner or admin role.
Authorization
bearer_auth In: header
Path Parameters
User ID
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/users/string"{ "ok": true}Re-enables a previously disabled user.
Authorization
bearer_auth In: header
Path Parameters
User ID
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/users/string/enable"{ "user": { "avatar_url": "string", "created_at": 0, "display_name": "string", "email": "string", "id": "string", "role": "owner", "status": "active", "updated_at": 0 }}Changes a user's role. Requires owner or admin role.
Authorization
bearer_auth In: header
Path Parameters
User ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/users/string/role" \ -H "Content-Type: application/json" \ -d '{ "role": "string" }'{ "user": { "avatar_url": "string", "created_at": 0, "display_name": "string", "email": "string", "id": "string", "role": "owner", "status": "active", "updated_at": 0 }}