Personal Account API

The Personal Account API allows administrators to list, update, deactivate, and restore user accounts programmatically.

Tip

For complete API documentation, including request/response schemas, visit the API docs.

All endpoints use the base URL of your Qualytics deployment (e.g., https://your-instance.qualytics.io/api).

Note

Personal Accounts cannot be created via API. Users are provisioned automatically through SSO (first login) or Directory Sync (SCIM).

List Users

Retrieve a paginated list of users with optional filters.

Endpoint:

GET /api/users
Authorization: Bearer {token}

Query Parameters:

Parameter	Type	Description
`sort`	string	Sort field (e.g., `name`, `created`, `role`, `type`, `last_login`)
`sort_dir`	string	Sort direction (`asc` or `desc`)
`name`	string	Filter by user name (partial match)
`role`	string	Filter by role (`Admin`, `Manager`, `Member`)
`team`	string	Filter by team name
`type`	string	Filter by user type (`Human`, `Service`)
`include_deleted`	boolean	Include deactivated users in results

Required Role: Manager or Admin

Retrieve a single user by ID.

Endpoint:

GET /api/users/{id}
Authorization: Bearer {token}

Required Role: Manager or Admin

Update a user's role or team assignments.

Endpoint:

PUT /api/users/{id}
Authorization: Bearer {admin_token}
Content-Type: application/json

Request Body:

{
  "role": "Manager",
  "teams": ["Data Engineering", "Data Quality"]
}

Required Role: Admin

Soft-delete a user account. The user can no longer log in but their account can be restored later.

Endpoint:

DELETE /api/users/{id}
Authorization: Bearer {admin_token}

Required Role: Admin

Restore a previously deactivated user account.

Endpoint:

PATCH /api/users/{id}
Authorization: Bearer {admin_token}

Required Role: Admin

Retrieve the currently authenticated user's information.

Endpoint:

GET /api/users/me
Authorization: Bearer {token}

Required Role: Member or above