API Documentation

Authentication

All API requests require an x-api-key header for authentication.

Headers: {
    "x-api-key": "your-api-key-here"
}
Find User

Endpoint: GET /api/user

Description: Find a user using an email address

Parameters:

  • email (query string): The email address of the user to find

Sample Request:

GET /api/user?email=user@example.com
Headers: {
    "x-api-key": "your-api-key-here"
}
List Users

Endpoint: GET /api/user/list

Description: Lists all users belonging to your Organization (determined from Auth Credentials)

Sample Request:

GET /api/user/list
Headers: {
    "x-api-key": "your-api-key-here"
}
Create User

Endpoint: POST /api/user

Description: Creates a new user

Request Body:

{
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "password": "string (optional, 8 or more characters)",
    "sendWelcomeEmail": boolean
}

Sample Request:

POST /api/user
Headers: {
    "x-api-key": "your-api-key-here",
    "Content-Type": "application/json"
}
Body: {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "password": "securepassword123",
    "sendWelcomeEmail": true
}