Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Path Parameters

personId
string<uuid>
required

Body

application/json
personLastDate
string<date>
required

Employee's last working date.

returnType
enum<string>
required

How the equipment will be returned.

Available options:
SHIP_TO_FIRSTBASE,
SHIP_TO_OFFICE,
DROPPED_TO_OFFICE
officeId
string<uuid>

Office ID. Required for SHIP_TO_OFFICE and DROPPED_TO_OFFICE return types.

itemsToReturn
object[]

Equipment to be returned or dropped off at the office. Behavior depends on returnType: ship paths create a return order; DROPPED_TO_OFFICE assigns inventory to officeId. Every eligible inventory item must appear in exactly one of itemsToReturn or itemsToNotReturn. Must-return (Firstbase-supplied HaaS) items must be listed here.

itemsToNotReturn
object[]

Equipment NOT being returned (with deploy reasons). Every eligible inventory item must appear in exactly one of itemsToReturn or itemsToNotReturn.

address
object

Confirmed shipping address. Only allowed when addressValidationNeeded=false with a ship return type (SHIP_TO_FIRSTBASE/SHIP_TO_OFFICE) that has itemsToReturn. When supplied it overwrites the person's stored home address and is used for the return order. phoneNumber is optional; when omitted the person's existing phone number is preserved.

addressValidationNeeded
boolean
default:true

When true (default), employee confirms shipping address before the return kit is sent. When false, the return order is auto-confirmed using the admin-supplied address; if there are no items to return, the person transitions directly to INACTIVE.

Response

OK

A person (employee) record in Firstbase

id
string<uuid>
required

Unique identifier for this person

Example:

"e2bd9633-46b4-4286-85bd-3403a3f17e0f"

role
enum<string>
required

Role of this person within the organization (BASIC = standard employee, ADMIN = org admin)

Available options:
BASIC,
ADMIN
Example:

"BASIC"

firstName
string
required

First name of the person

Example:

"Jenny"

lastName
string
required

Last name of the person

Example:

"Smith"

email
string
required

Primary email address, used for platform login and notifications

Example:

"jenny@example.com"

status
enum<string>
required

Current lifecycle status of the person in Firstbase (e.g. INVITED, ACTIVE, OFFBOARDING)

Available options:
INVITED,
ACTIVE,
INACTIVE,
DELETED,
OFFBOARDING,
CANNOT_REACTIVATE
secondaryEmail
string

Secondary email address; null when not provided

Example:

"jenny@secondary.example.com"

phoneNumber
string

Phone number from the person's home address; null when not provided

Example:

"555-867-5309"

startDate
string<date>

Employment start date, used to trigger onboarding timelines

Example:

"2023-11-22"

homeAddress
object

Home address of the person, used for equipment deliveries

package
object

Equipment package currently assigned to this person; null when no package is assigned

cpfNumber
string

Brazilian CPF tax number; null for non-Brazilian employees

Example:

87523654789