Uptimeify Docs

Appearance

Team Members ​

Manage users within your organization.

Endpoints ​

List Users ​

GET /api/users

Lists all users in the organization.

Response ​

json
[
  {
    "id": "user_123",
    "name": "John Doe",
    "email": "john@example.com",
    "role": "admin",
    "isActive": true,
    "createdAt": "2023-01-01T00:00:00Z"
  }
]

Add User ​

POST /api/users

Adds a new user to the organization.

Request Body ​

json
{
  "email": "jane@example.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "role": "user", // "admin" or "user"
  "password": "temporaryPassword123", // Optional, user can set it later
  "customerIds": [1, 2] // Optional: Limit access to specific customers
}

Get User Details ​

GET /api/users/:id

Returns details of a specific user.

Update User ​

PUT /api/users/:id

Updates a user's details and permissions.

Request Body ​

json
{
  "firstName": "Jane",
  "lastName": "Smith",
  "role": "admin",
  "isActive": true,
  "customerIds": [1, 2, 3] // Update customer access list
}

Remove User ​

DELETE /api/users/:id

Removes a user from the organization.