API docs by Redocly

User API (1.0.0)

Download OpenAPI specification:

License: MIT

API for user management

Get user by ID

path Parameters
user_id
required
integer

ID of the user

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "email": "string",
  • "tag": "string"
}

Register a new user

Request Body schema: application/json
required
email
required
string <email>
name
required
string
tag
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "name": "string",
  • "tag": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "token": {
    }
}

Login existing user

Request Body schema: application/json
required
email
required
string <email>
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "token": {
    }
}

Authenticate current user

Request Body schema: application/json
required
token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "token": {
    }
}

Find users by tag

Returns a list of users whose tag matches or is similar to the query.

query Parameters
tag
required
string

Tag or partial tag to search for

Responses

Response samples

Content type
application/json
[
  • {
    }
]