Users

Create, read, update and delete the people on your account, and query them as a table.

📄️List enabled locales

The locales a user can be created or updated with: the platform's enabled locales, as the sign-in app lists them.

📄️Create a user

Creates a user on the account. No assessment is assigned: invite the person through a [campaign](/guides/campaigns) or assign one with `PUT /users/{user_id}/assessments/{assessment_library_id}`. Fires the `UserCreated` webhook.

📄️Get a user by e-mail

Same shape as `GET /users/{user_id}`. `404` when no user of the account has this address.

📄️Get a user by employee id

Looks the user up by the employee id set through SCIM (`externalId`), the CSV import or `PATCH /users/{user_id}`. Same shape as `GET /users/{user_id}`.

📄️Get a user

The user with profile, account, status and groups.

📄️Delete a user

Removes the user and their results from the account. Fires the `UserDeleted` webhook. Prefer `PATCH` with `active: false` to keep results.

📄️Update a user

Update a user: names, e-mail, locale, employee id, active flag and tags. Partial; omitted fields are left alone.

📄️Get a user's competency scores

Scores for each competency of the account's competency model, keyed by competency identifier. Empty when the account has no competencies or the user has not completed the required assessments.

📄️Get a user with the scores of every completed assessment

Scales are keyed by scale name; `Parent//Child` keys are sub-scales and differ per assessment (`score_type`). `reports` lists the reports visible to the person, whose `assigned_user_report.id` can be used for PDFs and share links. See [Assessments & reports](/guides/assessments-and-reports).

📄️List the columns and table views for user table queries

Returns every queryable user column with its `type` (`keyword`, `numeric`, `date`, `name`, `email`) plus predefined table views whose `payload` can be sent as-is to `POST /users/table`. See the [Table queries](/getting-started/table-queries) guide.

📄️Query users as a table

Choose `columns` from `GET /users/columns`, filter, sort and paginate. Rows are objects keyed by column. Limits: 100 columns, 5 filters, 1 sort, 500 rows per page. See the [Table queries](/getting-started/table-queries) guide.

📄️Import users from a CSV file

Adds and updates users, optionally with their manager (team data) and HRIS attributes. Runs in the background. File rules in the [CSV user import](/guides/bulk-data-import) guide.