Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Shashank-H/gaiter-gaurd/llms.txt

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

​
Register user

Create a new user account with email and password.

​
Request body

​
email
string
required
User email address. Must be a valid email format.
​
password
string
required
User password. Must be at least 8 characters long.

​
Response

​
message
string
Success message confirming user registration.
​
user
object

​
Status codes

  • 201 - User successfully registered
  • 400 - Invalid email format or password requirements not met
  • 409 - User with this email already exists
  • 500 - Registration failed due to server error
curl --request POST \
  --url https://api.gaiterguard.com/auth/register \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "user@example.com",
    "password": "securePassword123"
  }'

{
  "message": "User registered",
  "user": {
    "id": 1,
    "email": "user@example.com",
    "createdAt": "2026-03-03T22:49:00.000Z"
  }
}

​
Login user

Authenticate a user and receive access and refresh tokens.

​
Request body

​
email
string
required
User email address.
​
password
string
required
User password.

​
Response

​
accessToken
string
JWT access token for authenticating API requests. Valid for a limited time.
​
refreshToken
string
JWT refresh token for obtaining new access tokens.
​
user
object

​
Status codes

  • 200 - Login successful
  • 400 - Email and password are required
  • 401 - Invalid credentials
  • 500 - Login failed due to server error
curl --request POST \
  --url https://api.gaiterguard.com/auth/login \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "user@example.com",
    "password": "securePassword123"
  }'

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": 1,
    "email": "user@example.com",
    "createdAt": "2026-03-03T22:49:00.000Z"
  }
}

​
Refresh access token

Obtain a new access token using a valid refresh token.

​
Request body

​
refreshToken
string
required
Valid refresh token obtained from login.

​
Response

​
accessToken
string
New JWT access token for authenticating API requests.
​
refreshToken
string
New JWT refresh token (rotated for security).

​
Status codes

  • 200 - Token refresh successful
  • 400 - Refresh token is required
  • 401 - Invalid refresh token
  • 500 - Token refresh failed due to server error
curl --request POST \
  --url https://api.gaiterguard.com/auth/refresh \
  --header 'Content-Type: application/json' \
  --data '{
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }'

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

​
Get current user

Retrieve the authenticated user’s profile information.
This endpoint requires authentication.

​
Headers

​
Authorization
string
required
Bearer token for authentication. Format: Bearer <jwt>

​
Response

​
user
object

​
Status codes

  • 200 - User profile retrieved successfully
  • 401 - Unauthorized (missing or invalid token)
  • 404 - User not found
  • 500 - Failed to get user info
curl --request GET \
  --url https://api.gaiterguard.com/auth/me \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

{
  "user": {
    "id": 1,
    "email": "user@example.com",
    "createdAt": "2026-03-03T22:49:00.000Z"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us