Skip to main content
POST
Create Employee

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Create employee payload

name
string
required

Employee name

Example:

"Maria Silva"

email
string<email>
required

Employee email

Example:

"employee@example.com"

phoneDdi
string
required

International dialing code

Example:

"55"

phoneNumber
string
required

Phone number without country code

Example:

"99999999999"

employeeCode
string | null

Employee code

Example:

"EMP-1024"

jobTitle
string | null

Job title

Example:

"Atendente"

department
string | null

Department

Example:

"Operacao"

phoneIso
string

Phone ISO country code

Example:

"BR"

Response

Created

Employee

employee
object
required
invite
object | null
required

Invite