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

# Create Users Api

`POST /api/v1/users`

## Request

- Base URL: `https://public-api.linearb.io`
- URL: `https://public-api.linearb.io/api/v1/users`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/linearb/apis/linearb-api/docs/api/v1/users/post.ts> (a function with typed inputs; its response is checked against the schema)

Users API endpoint performs a LinearB users creation.

## Request body

- UserCreationModel[]
  - `name` string, required: username must be at least 3 characters long, start with a letter
  - `email` string, required: User's email address
  - `permission` Permission
    - `role` 'admin' | 'editor' | 'viewer' | 'external' | 'basic': An enumeration.
    - `team_scopes` string[]
    - `view_dev_coaching` boolean
  - `team_membership` TeamMembership[]
    - `name` string, required
    - `joined_at` string: The date when the user joined the team (format: YYYY-MM-DD)
  - `custom_info` CustomInfo
    - `extra_emails` string[]: User extra emails
    - `extra_ids` string[]

## Response `200`

Successful Response

## Other responses

- `202`: Successful Response
- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `405`: Method Not Allowed
- `409`: Conflict
- `422`: Validation Error
- `500`: Internal Server Error
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/linearb/apis/linearb-api.md) - [All operations](https://skmtc.dev/linearb/apis/linearb-api/llms.txt) - [OpenAPI document](https://skmtc.dev/linearb/apis/linearb-api/revisions/3aea06710db6?raw)