Users

User management endpoints

Add phone number

post

Add phone number to user account and send verification SMS (required for all users)

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Request payload for adding phone number to user account

phone_numberstringRequired

Valid phone number in E.164 format (e.g., [phone]). Must include country code and contain only digits after the '+' sign.

Example: [phone]Pattern: ^\+[1-9][0-9]{7,14}$

Responses

200

Phone number added successfully, verification SMS sent

application/json

400

Invalid phone number format or missing required fields.

application/json

401

Missing or invalid authentication token.

application/json

409

Phone number already exists or already verified.

application/json

500

Internal server error occurred while adding phone number.

application/json

post

/api/v1/users/add-phone

HTTPcURLJavaScriptPython

POST /api/v1/users/add-phone HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "phone_number": "[phone]"
}

{
  "phone_number": "[phone]",
  "verification_sent": true,
  "message": "Phone number added successfully. Please verify using the SMS code sent to your phone."
}

Get current user's details

get

Retrieve current user's details

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Profile retrieved successfully

application/json

401

Missing or invalid authentication token.

application/json

404

User not found.

application/json

500

Internal server error occurred while retrieving user's details.

application/json

get

/api/v1/users/me

HTTPcURLJavaScriptPython

GET /api/v1/users/me HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "[email protected]",
  "first_name": "John",
  "middle_name": "Michael",
  "last_name": "Doe",
  "phone_number": "[phone]",
  "status": "active",
  "email_verified": false,
  "phone_verified": false,
  "oauth_provider": "google",
  "oauth_provider_id": "123456789",
  "email_verified_at": "2025-08-13T12:35:00Z",
  "phone_verified_at": "2025-08-13T12:36:00Z",
  "created_at": "2025-08-13T12:34:56Z",
  "updated_at": "2025-08-14T09:21:45Z",
  "roles": {
    "organizations": [
      {
        "org_id": "org-jhyR3C6vCqP",
        "role": "admin"
      }
    ],
    "projects": [
      {
        "org_id": "org-jhyR3C6vCqP",
        "project_id": "prj-QDmnerkgMg",
        "role": "admin"
      }
    ]
  }
}

Delete current user's account

delete

Delete current user's account

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Request payload for deleting current user's account

passwordstringWrite-onlyRequired

Password for verification

Example: SecurePass@123

Responses

200

Account deleted successfully

application/json

400

Invalid password or missing required fields.

application/json

401

Missing or invalid authentication token.

application/json

404

User not found.

application/json

500

Internal server error occurred while deleting account.

application/json

delete

/api/v1/users/me

HTTPcURLJavaScriptPython

DELETE /api/v1/users/me HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "password": "SecurePass@123"
}

{
  "message": "Operation completed successfully"
}

Change password

put

Change current user's password (requires current password verification)

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Request payload for changing user's password

current_passwordstring · passwordWrite-onlyRequired

Current password for verification

Example: CurrentSecurePass@123

new_passwordstring · password · min: 8 · max: 50Write-onlyRequired

New password for the user account. Must be at least 8 characters long, and contain at least one uppercase letter, one lowercase letter, one digit, and one special character.

Example: NewSecurePass@123

Responses

200

Password changed successfully

application/json

400

Invalid password format or missing required fields.

application/json

401

Missing or invalid authentication token, or current password is incorrect.

application/json

500

Internal server error occurred while changing password.

application/json

put

/api/v1/users/me/change-password

HTTPcURLJavaScriptPython

PUT /api/v1/users/me/change-password HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "current_password": "CurrentSecurePass@123",
  "new_password": "NewSecurePass@123"
}

{
  "message": "Operation completed successfully"
}