Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/whitiue/logiMathApp/llms.txt

Use this file to discover all available pages before exploring further.

The Users API provides two endpoints for managing LogiMath accounts. You can retrieve a list of all registered users or create a new user by supplying a name and email as query parameters. The password_hash field is persisted in the database for authentication purposes but is deliberately excluded from all API responses — only id, name, and email are returned.

​
GET /users

Returns all users registered in the LogiMath database. 
curl http://localhost:8000/users

​
Response

Returns an array of UserResponse objects. 
[
  {
    "id": 1,
    "name": "Alice Mora",
    "email": "alice@example.com"
  },
  {
    "id": 2,
    "name": "Bob Liang",
    "email": "bob@example.com"
  }
]
​
id
integer
required
Auto-incremented primary key for the user record.
​
name
string
required
Display name of the user.
​
email
string
required
Email address of the user. Unique across all accounts.

​
POST /users

Creates a new user account. Both parameters are passed as query parameters in the request URL.
​
name
string
required
Full name of the new user.
​
email
string
required
Email address for the new account. Must be unique — the database enforces a unique constraint on this column.
curl -X POST "http://localhost:8000/users?name=Alice%20Mora&email=alice%40example.com"

​
Response

Returns the created UserResponse object. 
{
  "id": 1,
  "name": "Alice Mora",
  "email": "alice@example.com"
}
​
id
integer
required
Auto-assigned primary key for the newly created user.
​
name
string
required
Name provided in the request.
​
email
string
required
Email address provided in the request.
Although the database stores a password_hash column on the users table, it is not accepted as a parameter by this endpoint and is not returned in any response. The UserResponse Pydantic model intentionally omits it.

Build docs developers (and LLMs) love

Get started for freeTalk to us