Fetch a user
GET /users/{id}
GET /users/{id}
Operation
GET
/users/{id}
Fetches a single user. Admins may read any user; non-admin callers may only read their own record.
Operation ID:
getUser
·
Tags: Users
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id
|
path | Yes | integer | — |
Request Body
No request body is defined for this operation.
Responses
Content Types
application/json
{
"description": "User (JSON:API envelope from UserSerializer)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"user"
]
},
"attributes": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
}
}
}
}{
"$ref": "#/components/responses/Unauthorized"
}{
"$ref": "#/components/responses/Forbidden"
}{
"$ref": "#/components/responses/NotFound"
}API Playground
Run this GET request with your API key, or open it in a new tab. Path uses sample IDs where the OpenAPI path has {parameters}.
Sign in to enable live testing with your API key.
| Action | Method | Endpoint | Description |
|---|---|---|---|
| Fetch a user | GET |
/api/v1/users/1 |
OpenAPI operationId: getUser. |
GET /api/v1/users/1
OpenAPI
Fetch a user