User Endpoints
GET
Fetch an individual user's details.
Request parameters
Responses
{
"uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"username": "Bob",
"image": "base64 ........",
"imageMime": "image/gif",
"description": "I'm bob and i love cats. I live in catworld and have 2^64 cats in my house. Their names are the fibonacci sequence. Except cat number 42 whose name is Megatron.",
"pronouns": "hee/hee",
"cats": [
"ffffffff-ffff-ffff-ffff-ffffffffffff"
],
"wishlist": [
"ffffffff-ffff-ffff-ffff-ffffffffffff"
]
}
{
"error": "Bad Request",
"status": 400,
"field_errors": [
"email"
]
}
{
"error": "User account is not verified",
"status": 403
}
{
"error": "Not found",
"status": 404,
"reason": "Requested path could not be found"
}
{
"error": "Server Error",
"status": 500,
"exception": "Baz given, expected Foo or Bar",
"trace": "example",
"thrownIn": "\App\Foo\Bar\Baz()",
"file": "example",
"line": 58,
"severity": "example"
}
PUT
Update your user's details. Requires authorization
Request parameters
{
"description": "I'm Bob and my best friend is Alice",
"pronouns": "her/icopter",
"image": "example",
"image_mime": "example"
}
Responses
{
"uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"username": "Bob",
"image": "base64 ........",
"imageMime": "image/gif",
"description": "I'm bob and i love cats. I live in catworld and have 2^64 cats in my house. Their names are the fibonacci sequence. Except cat number 42 whose name is Megatron.",
"pronouns": "hee/hee",
"cats": [
"ffffffff-ffff-ffff-ffff-ffffffffffff"
],
"wishlist": [
"ffffffff-ffff-ffff-ffff-ffffffffffff"
]
}
{
"error": "Bad Request",
"status": 400,
"field_errors": [
"email"
]
}
{
"error": "Unauthorized",
"status": 401,
"reason": "Unauthorized"
}
{
"error": "User account is not verified",
"status": 403
}
{
"error": "Not found",
"status": 404,
"reason": "Requested path could not be found"
}
{
"error": "Server Error",
"status": 500,
"exception": "Baz given, expected Foo or Bar",
"trace": "example",
"thrownIn": "\App\Foo\Bar\Baz()",
"file": "example",
"line": 58,
"severity": "example"
}
DELETE
Delete your own user. Requires authorization.
Request parameters
Responses
{
"success": "true"
}
{
"error": "Bad Request",
"status": 400,
"field_errors": [
"email"
]
}
{
"error": "Unauthorized",
"status": 401,
"reason": "Unauthorized"
}
{
"error": "Not found",
"status": 404,
"reason": "Requested path could not be found"
}
{
"error": "Server Error",
"status": 500,
"exception": "Baz given, expected Foo or Bar",
"trace": "example",
"thrownIn": "\App\Foo\Bar\Baz()",
"file": "example",
"line": 58,
"severity": "example"
}
Last modified: 27 January 2025