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

There is no direct create operation for Personal Accounts. Accounts are created through an email invitation, a first sign-in through a sign-in provider, or Directory Sync (SCIM). The invitation endpoints are documented on the Sign-In Providers API page.

List Users

Retrieve a paginated list of users with optional filters.

Endpoint:

GET /api/users
Authorization: Bearer {token}

Query Parameters:

Parameter	Type	Description
`sort_name`	string	Sort by name (`asc` or `desc`)
`sort_created`	string	Sort by creation date (`asc` or `desc`)
`sort_team`	string	Sort by team (`asc` or `desc`)
`sort_status`	string	Sort by status (`asc` or `desc`)
`sort_role`	string	Sort by role (`asc` or `desc`)
`sort_type`	string	Sort by user type (`asc` or `desc`)
`sort_last_login`	string	Sort by last sign-in (`asc` or `desc`)
`name`	string	Filter by user name or email (partial match, case-insensitive)
`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

Reviewing identity provider groups

For accounts provisioned through OIDC, each user in the response carries an oidc_groups field holding the group names the identity provider presented at that user's last sign-in. Compare it against the user's teams to audit group-based Team membership. See Just-in-Time Provisioning and Group Sync.

Get User

Retrieve a single user by ID.

Endpoint:

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

Required Role: Manager or Admin

Update User

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

Deactivate User

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

Reactivate User

Restore a previously deactivated user account.

Endpoint:

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

Required Role: Admin

Get Current User

Retrieve the currently authenticated user's information.

Endpoint:

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

Required Role: Member or above