Get the authenticated user
GET /user. Parameters, permissions, request and response schemas.
GET /user
Get the authenticated user. Requires the REST read token ability. The bearer token selects the Team; a supplied team_id cannot switch tenants. Additional role, entity-policy and plan requirements vary by operation.
Authentication
Use a team API key as Authorization: Bearer YOUR_API_KEY. The token ability and the user’s role must both allow this operation. See authentication.
{
"ability": "read",
"team": "Token-bound Team",
"authorization": "Additional role, entity-policy and plan requirements vary by operation."
}Example request
curl --request GET 'https://api.example.test/api/user' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Accept: application/json'Examples use fictional data. Replace resource IDs and the API host with your environment’s values.
Responses
200
User
Content type: application/json.
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"avatar": {
"type": [
"string",
"null"
]
},
"email": {
"type": "string"
},
"timezone": {
"type": [
"string",
"null"
]
},
"email_verified_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"last_login_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"last_visited_team_id": {
"type": [
"integer",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"name",
"avatar",
"email",
"timezone",
"email_verified_at",
"last_login_at",
"last_visited_team_id",
"created_at",
"updated_at"
],
"title": "User"
}{
"id": 101,
"name": "Checkout delivery estimate",
"avatar": null,
"email": "alex@example.com",
"timezone": null,
"email_verified_at": null,
"last_login_at": null,
"last_visited_team_id": null,
"created_at": null,
"updated_at": null
}401
Unauthenticated
Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}{
"message": "The request could not be completed."
}403
Token ability, user permission, Team membership, plan, or billing mode does not allow this operation.
Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "This action is unauthorized."
}
},
"required": [
"message"
]
}{
"message": "This action is unauthorized."
}429
Rate limit exceeded. Honor Retry-After before retrying.
Response headers:
{
"Retry-After": {
"description": "Seconds before retrying.",
"schema": {
"type": "integer"
}
}
}Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Too Many Attempts."
}
},
"required": [
"message"
]
}{
"message": "Too Many Attempts."
}See API conventions for error handling, rate limits, pagination, and uploads.