Skip to main content
POST
/
v1
/
users
Create User
curl --request POST \
  --url https://api.example.com/v1/users/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "password": "<string>",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "is_active": true,
  "is_superuser": false,
  "is_verified": false,
  "given_name": "<string>",
  "family_name": "<string>",
  "external_user_id": "<string>",
  "profile_image": "<string>",
  "password_change_required": false,
  "is_super_admin": false
}

Body

application/json

Request model for creating a user with team assignment.

email
string<email>
required

User email address

password
string
required

User password

Minimum string length: 8
team_id
string<uuid>
required

ID of the team to assign the user to

given_name
string | null

User's given name

family_name
string | null

User's family name

external_user_id
string | null

External user identifier

profile_image
string<uri> | null

URL to user's profile image

Required string length: 1 - 2083
password_change_required
boolean
default:true

Whether the user must change their password on first login

Response

Successful Response

Returned to clients when reading user info.

id
string<uuid>
required
email
string<email>
required
is_active
boolean
default:true
is_superuser
boolean
default:false
is_verified
boolean
default:false
given_name
string | null
family_name
string | null
external_user_id
string | null
profile_image
string<uri> | null
Required string length: 1 - 2083
password_change_required
boolean
default:false
is_super_admin
boolean
default:false
Last modified on April 21, 2026