Error
A valid request URL is required to generate request examples{
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "jsmith@example.com",
"avatar_url": "<string>",
"totp_enabled": true,
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Account
Read the account
The signed-in person, as distinct from the organization they are acting in: their name, their address, whether they hold a second factor. A user always administers themselves, so this is behind no permission — every member of every organization can read it.
GET
/
v1
/
account
Error
A valid request URL is required to generate request examples{
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "jsmith@example.com",
"avatar_url": "<string>",
"totp_enabled": true,
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Resposta
The account.
The public shape of a user. What is not listed here — the password hash, the TOTP secret — never reaches a response body.
Show child attributes
Show child attributes