---
title: "Create user"
method: POST
path: "/api/v1/users"
tags: ["Users"]
---

# Create user

`POST /api/v1/users`

Create a user by specifying personal and review related attributes.

        When specifying review details (form, process, manager, and archive date), a corresponding Review Set and Review will be created.

        If review details are not supplied, no Review will exist for this user and their ability to interact with the system will be limited.

## Query parameters

- `include` string

## Headers

- `Content-Type` string, required

## Request body

- object
  - `data` object
    - `type` string
    - `attributes` object
      - `first_name` string — first_name must be present
      - `last_name` string — last_name must be present
      - `employee_number` string — employee_number must be present and unique amongst all employees within your organization.
      - `username` string — username must be present and unique amongst all employees within your organization.
      - `email` string — email must be present if organization has Mitratech HQ integration enabled.
      - `hire_date` string — Please use the format YYYY-MM-DD when providing dates.
      - `base_date` string — The base date for this user's review set. Please use the format YYYY-MM-DD when providing dates.
      - `password` string
      - `must_reset_password` boolean — If this option is set to true, the user will be required to change their password on the next login regardless of whether or not you're also passing along a password.
      - `form_name` string
      - `unrecognized_form_name_action` string — Optional attribute to be included to specify what action to take if the provided 'form_name' is not found. This can be either 'blank', or 'copy'. 'blank' will create a new, empty form with the 'form_name' provided. 'copy' will require the 'form_name_for_copy' attribute to be provided and a valid existing from to use as the basis for a copy while using the 'form_name' attribute for the copied forms new name.
      - `form_name_for_copy` string — When the 'unrecognized_form_name_action' attribute is provided and set to 'copy', this field will specify the existing form to lookup and copy while using the 'form_name' attribute as the new form's name.
      - `process_name` string
      - `manager_user_id` string — This is the user id of the person who will be assigned as the manager. This can be found by searching via our index routes and referencing the `id` field that gets returned. NOTE: this person must have the manager role in order to be assigned.
      - `review_archive_date` string — Primary Review Set Archive by date.
      - `group_ids` unknown[] — A list of any / all group ids a user should belong to.
        - unknown
      - `group_names` unknown[] — A list of group names a user should belong to.
        - unknown
      - `roles` unknown[] — Additional roles that a user can assume.
        - unknown
      - `locale_format` string — The user's format locale. Accepted values: 'auto' (resets to default), 'en', 'en_GB', 'en_CA', 'en_AU'.
      - `locale_lang` string — The user's language locale. Accepted values: 'auto' (resets to default), 'en', 'fr_CA'.

## Response `201`

user successfully created

## Other responses

- `400` — missing required attributes

---

[API](https://skmtc.net/trakstar/apis/service-api.md) · [All operations](https://skmtc.net/trakstar/apis/service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trakstar/service-api/revisions/a3ea128a9743/schema)