Help · API reference

You

The signed-in user.

Get the signed-in userGET /api/v1/me

Returns the caller's user record, the teams they belong to with their role and plan, projects reached through a per-project grant (guest_projects), the unread notification count, whether the session is stepped up (elevated), and the platform limits.

Who may call it: A signed-in session, or an access token (write to change anything)

200 Success.

What comes back

user object, required
- id string, required
- email string, required
- name string | null, required
- avatar_url string | null, required
- locale string, required
- commit_email_visible boolean, required
notifications_unread number, required
elevated boolean, required: Whether this session has stepped up; always false for a token.
box_operator true: Present when the caller runs this deployment.
platform_admin true: Present when the caller is platform staff.
deletion_grace_days number, required
dashboard_origin string, required
limits object, required
- projects_per_account number, required
- builds_per_day number, required
- upload_bytes number, required
guest_projects array of object, required
A list of:
- id string, required
- slug string, required
- name string, required
- status string, required
- role string, required
- account string, required: The name of the team the project belongs to.
accounts array of object, required
A list of:
- id string, required
- slug string, required
- name string, required
- type string, required
- plan string, required
- role string, required
- deleted_at string: Present only while a deletion is pending.
- purge_after string: Present only while a deletion is pending.

Errors it can answer

401 Authentication required. (code is unauthenticated.)
default Any other failure, as RFC 9457 problem details.