Offboard a person.
Authorizations
Prefix the value with "ApiKey" to indicate the custom authorization type
Path Parameters
Body
Employee's last working date.
How the equipment will be returned.
SHIP_TO_FIRSTBASE, SHIP_TO_OFFICE, DROPPED_TO_OFFICE Office ID. Required for SHIP_TO_OFFICE and DROPPED_TO_OFFICE return types.
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.
Equipment NOT being returned (with deploy reasons). Every eligible inventory item must appear in exactly one of itemsToReturn or itemsToNotReturn.
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.
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
Unique identifier for this person
"e2bd9633-46b4-4286-85bd-3403a3f17e0f"
Role of this person within the organization (BASIC = standard employee, ADMIN = org admin)
BASIC, ADMIN "BASIC"
First name of the person
"Jenny"
Last name of the person
"Smith"
Primary email address, used for platform login and notifications
"jenny@example.com"
Current lifecycle status of the person in Firstbase (e.g. INVITED, ACTIVE, OFFBOARDING)
INVITED, ACTIVE, INACTIVE, DELETED, OFFBOARDING, CANNOT_REACTIVATE Secondary email address; null when not provided
"jenny@secondary.example.com"
Phone number from the person's home address; null when not provided
"555-867-5309"
Employment start date, used to trigger onboarding timelines
"2023-11-22"
Home address of the person, used for equipment deliveries
Equipment package currently assigned to this person; null when no package is assigned
Brazilian CPF tax number; null for non-Brazilian employees
87523654789