Users

Create users in batch

post

This method allows creating multiple users in a single request.

Authorizations

PublicApiKey

x-api-keystringRequired

Header parameters

x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Body

application/json

usersstring[]Required

An array containing user objects with the following fields: external_user_id, email, first_name, last_name, and phone

Responses

201Success

application/json

idstringRequired

Unique internal identifier of the user

Example: 550e8400-e29b-41d4-a716-446655440000

emailstringRequired

The user's email address

Example: [email protected]

avatar_idobject · nullableRequired

URL to the user's avatar image

Example: https://example.com/avatar.jpg

first_namestringRequired

The user's first name

Example: Vova

last_namestringRequired

The user's last name

Example: Smith

external_user_idobject · nullableRequired

External identifier for the user assigned by third-party system

Example: ext_user_123456

full_namestringOptional

The user's full name (first name + last name)

Example: Vova Smith

phoneobject · nullableOptional

The user's phone number

Example: [phone]

statusstring · enumOptional

Current status of the user account

Example: ActivePossible values:

created_atstring · date-timeRequired

Timestamp when the user was created

Example: 2024-09-02T21:00:00.000Z

429

Returned when the rate limit is exceeded

post

/api/v1/public/users/batch

HTTPcURLJavaScriptPython

POST /api/v1/public/users/batch HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "users": [
    "text"
  ]
}

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "[email protected]",
    "avatar_id": "https://example.com/avatar.jpg",
    "first_name": "Vova",
    "last_name": "Smith",
    "external_user_id": "ext_user_123456",
    "full_name": "Vova Smith",
    "phone": "[phone]",
    "status": "Active",
    "created_at": "2024-09-02T21:00:00.000Z",
    "userVacations": [
      {
        "start_at": "2024-09-02T21:00:00.000Z",
        "end_at": "2024-09-15T21:00:00.000Z"
      }
    ]
  }
]