Skip to main content
POST
/
users
cURL
curl --request POST \
  --url https://api.axiom.co/v2/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "name": "Jane Doe",
  "role": "member"
}
'
{
  "email": "[email protected]",
  "id": "usr_123456789",
  "name": "John Doe",
  "role": {
    "id": "role_123456789",
    "name": "Organization Admin"
  }
}

Authorizations

​
Authorization
string
header
required

Authenticate using an API token or personal access token (PAT). Include the token as a Bearer token: Authorization: Bearer <token>. For more information, see Tokens.

Body

application/json

Object representing a new user creation request

​
email
string
required

Email address of the new user

Example:

"[email protected]"

​
name
string
required

Full name of the new user

Example:

"Jane Doe"

​
role
string
required

Role to assign to the new user

Example:

"member"

Response

200 - application/json

User

Represents a user in the system

​
email
string
required

User's email address

Example:

"[email protected]"

​
id
string
required

Unique identifier for the user

Example:

"usr_123456789"

​
name
string
required

User's full name

Example:

"John Doe"

​
role
object
required

Detailed information about a user's role