Starts offboarding for the person. May create return workflows depending on request body options (for example address confirmation and items not to return).
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> | null
Office ID. Required for SHIP_TO_OFFICE and DROPPED_TO_OFFICE return types.
itemsToReturn
object[] | null
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.
Show child attributes
itemsToNotReturn
object[] | null
Equipment NOT being returned (with deploy reasons). Every eligible inventory item must appear in exactly one of itemsToReturn or itemsToNotReturn.
Show child attributes
address
null
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"
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
identityEmail
string
Identity email address, used for platform login and notifications
Example:
"jenny@example.com"
email
string
Primary email address, used for platform login and notifications
Example:
"jenny@example.com"
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
Show child attributes
package
object
Equipment package currently assigned to this person; null when no package is assigned
Show child attributes
cpfNumber
string
Brazilian CPF tax number; null for non-Brazilian employees
Example:
"87523654789"
accessLevel
enum<string>
read-only
Platform access level. BASIC is a standard employee, ADMIN is a full org admin, ADMIN_READ_ONLY is a read-only org admin. Omitted when the person has no access level.
Available options:
BASIC,
ADMIN,
ADMIN_READ_ONLY
Example:
"BASIC"
lastDay
string<date>
read-only
Last working day recorded at offboarding (platform "Last Day"), ISO 8601 date. Omitted when the person has no Last Day.
Example:
"2026-01-31"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Firstbase API","description":"Integration endpoints for provisioning, inventory, orders, and people management.","colors":{"primary":"#f2555a","light":"#f2555a","dark":"#d94449"},"logo":{"light":"https://mintcdn.com/firstbase-cd088419/DDV5t2EOeCNU8R4K/logo/light.svg?fit=max\u0026auto=format\u0026n=DDV5t2EOeCNU8R4K\u0026q=85\u0026s=e22f02de6760918dfb83ad51b00a4dd8","dark":"https://mintcdn.com/firstbase-cd088419/DDV5t2EOeCNU8R4K/logo/dark.svg?fit=max\u0026auto=format\u0026n=DDV5t2EOeCNU8R4K\u0026q=85\u0026s=8aa1a519222b541c81f34991b82a3990"},"favicon":"https://mintcdn.com/firstbase-cd088419/DDV5t2EOeCNU8R4K/favicon.svg?fit=max\u0026auto=format\u0026n=DDV5t2EOeCNU8R4K\u0026q=85\u0026s=185b8a75ba7c0a1463d02bfb7faba5c7","api":{"openapi":"openapi.json","playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":true,"autogenerate":true},"url":"full","mdx":{"server":"https://apipub.firstbasehq.com"}},"navbar":{"links":[],"primary":{"type":"button","label":"App","href":"https://app.firstbasehq.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Getting Started","icon":"rocket","href":"/"},{"anchor":"Swagger UI","icon":"code","href":"https://apipub.firstbasehq.com/swagger-ui/index.html"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"firstbase-cd088419","hasAudioNarration":false,"actualSubdomain":"firstbase-cd088419","customDomains":["developers.firstbase.com"],"gitSource":{"type":"github","owner":"appdirect","repo":"firstbase-app","deployBranch":"development","contentDirectory":"public-api-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afc966607e1f860fc0f5845","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"People","count":10},{"language":"default","tag":"Inventory","count":6},{"language":"default","tag":"Orders","count":6},{"language":"default","tag":"Packages","count":6},{"language":"default","tag":"Inventory Orders","count":5},{"language":"default","tag":"Returns","count":5},{"language":"default","tag":"Shipment Notices","count":5},{"language":"default","tag":"Catalog","count":4},{"language":"default","tag":"Inventory Levels","count":4},{"language":"default","tag":"ITAD","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/people/offboard-person","slug":"/api-reference/people/offboard-person","pageMetadata":{"title":"Offboard person","description":"Starts offboarding for the person. May create return workflows depending on request body options (for example address confirmation and items not to return).","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/people/{personId}/offboard","href":"/api-reference/people/offboard-person","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Starts offboarding for the person. May create return workflows depending on request body options (for example address confirmation and items not to return).\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Offboard person","description":"Starts offboarding for the person. May create return workflows depending on request body options (for example address confirmation and items not to return).","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/people/{personId}/offboard","href":"/api-reference/people/offboard-person","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/firstbase-cd088419/eb8be295fb0c99cf/test/security/dep-versions.test.js","/_mintlify/custom/firstbase-cd088419/a351a42a1eff512c/test/security/qs-dos.test.js"],"openApiReferenceData":{"operation":{"tags":["People"],"summary":"Offboard person","operationId":"offboard","parameters":["536e3034-84da-40b7-8666-93c3c32ec3a3"],"requestBody":"047c3bfa-8e62-4fcf-a885-211b63e0f592","responses":{"200":"4e1e2c86-be4e-420e-bde7-7bf38ffc0919","400":"41541e99-ce3a-48b1-a8e5-ca35582a6680","403":"05b1a229-2b5a-492f-84f7-219349a57fd2","404":"5a0dbb17-3fd5-4a15-a400-e4fec52900d3","409":"79ff5ac4-1db1-475c-bee1-9bc27c1b112f"},"description":"Starts offboarding for the person. May create return workflows depending on request body options (for example address confirmation and items not to return).","x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -sS -X POST 'https://apipub.firstbasehq.com/api/v1/people/{personId}/offboard' \\\n -H 'Authorization: ApiKey YOUR_API_KEY' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"address\": {\n \"addressLine1\": \"123 Sesame Street\",\n \"addressLine2\": \"Suite 103\",\n \"administrativeArea\": \"NY\",\n \"countryCode\": \"US\",\n \"locality\": \"New York City\",\n \"postalCode\": \"10123\",\n \"phoneNumber\": \"555-867-5309\"\n }\n }'"}],"method":"post","type":"path","servers":["c72a91e2-ce89-42c6-8eda-72a67db3f3b0"],"security":["1e65b031-3712-4e0e-af72-36a1881b7f28"],"path":"/api/v1/people/{personId}/offboard","baseUrlOptions":["https://apipub.firstbasehq.com"],"title":"Offboard person","codeSamples":[{"label":"cURL","lang":"curl","source":"curl -sS -X POST 'https://apipub.firstbasehq.com/api/v1/people/{personId}/offboard' \\\n -H 'Authorization: ApiKey YOUR_API_KEY' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"address\": {\n \"addressLine1\": \"123 Sesame Street\",\n \"addressLine2\": \"Suite 103\",\n \"administrativeArea\": \"NY\",\n \"countryCode\": \"US\",\n \"locality\": \"New York City\",\n \"postalCode\": \"10123\",\n \"phoneNumber\": \"555-867-5309\"\n }\n }'"}],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"codeSamples","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.address":{"addressLine1":"123 Sesame Street","addressLine2":"Suite 103","administrativeArea":"NY","countryCode":"US","locality":"New York City","postalCode":"10123","phoneNumber":"555-867-5309"}}],"urlDisplay":"full"},"dependencies":{"parameters":{"536e3034-84da-40b7-8666-93c3c32ec3a3":{"name":"personId","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"personLastDate":{"type":"string","format":"date","description":"Employee's last working date.","isRequired":true,"uniqueKey":"personLastDate","typeLabel":"string\u003cdate>"},"returnType":{"type":"string","description":"How the equipment will be returned.","enum":["SHIP_TO_FIRSTBASE","SHIP_TO_OFFICE","DROPPED_TO_OFFICE"],"isRequired":true,"uniqueKey":"returnType","typeLabel":"enum\u003cstring>"},"officeId":{"oneOf":[{"type":"string","format":"uuid","description":"Office ID. Required for SHIP_TO_OFFICE and DROPPED_TO_OFFICE return types.","uniqueKey":"officeId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Office ID. Required for SHIP_TO_OFFICE and DROPPED_TO_OFFICE return types.","uniqueKey":"officeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"officeId","typeLabel":"string\u003cuuid> | null"},"itemsToReturn":{"oneOf":[{"type":"array","description":"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.","items":{"type":"object","properties":{"inventoryId":{"type":"string","format":"uuid","description":"Inventory ID being returned or dropped off at office.","isRequired":true,"uniqueKey":"itemsToReturn.oneOf.0.items.[INDEX].inventoryId","typeLabel":"string\u003cuuid>"},"returnReasonComment":{"oneOf":[{"type":"string","description":"Optional free-text comment about the return. Only used for ship return types (SHIP_TO_FIRSTBASE, SHIP_TO_OFFICE). Rejected when non-blank on DROPPED_TO_OFFICE.","maxLength":500,"minLength":0,"uniqueKey":"itemsToReturn.oneOf.0.items.[INDEX].returnReasonComment.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional free-text comment about the return. Only used for ship return types (SHIP_TO_FIRSTBASE, SHIP_TO_OFFICE). Rejected when non-blank on DROPPED_TO_OFFICE.","maxLength":500,"minLength":0,"uniqueKey":"itemsToReturn.oneOf.0.items.[INDEX].returnReasonComment.oneOf.1","typeLabel":"null"}],"uniqueKey":"itemsToReturn.oneOf.0.items.[INDEX].returnReasonComment","typeLabel":"string | null"},"itad":{"oneOf":[{"type":"boolean","description":"Whether to elect ITAD (IT Asset Disposition) for this item. Only used for ship return types. Not allowed for subscription/HaaS items. Rejected when true on DROPPED_TO_OFFICE.","uniqueKey":"itemsToReturn.oneOf.0.items.[INDEX].itad.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether to elect ITAD (IT Asset Disposition) for this item. Only used for ship return types. Not allowed for subscription/HaaS items. Rejected when true on DROPPED_TO_OFFICE.","uniqueKey":"itemsToReturn.oneOf.0.items.[INDEX].itad.oneOf.1","typeLabel":"null"}],"uniqueKey":"itemsToReturn.oneOf.0.items.[INDEX].itad","typeLabel":"boolean | null"},"holdRequested":{"oneOf":[{"type":"boolean","description":"Whether to request a machine retention hold for this item. Only used for ship return types. Only available when this capability is enabled for your organization. When available and the organization's retention policy for the person's region is AD_HOC, set to true to request a hold. Omitted or null is treated as false. Sending this field when the capability is unavailable returns 403. Rejected when true on DROPPED_TO_OFFICE.","uniqueKey":"itemsToReturn.oneOf.0.items.[INDEX].holdRequested.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether to request a machine retention hold for this item. Only used for ship return types. Only available when this capability is enabled for your organization. When available and the organization's retention policy for the person's region is AD_HOC, set to true to request a hold. Omitted or null is treated as false. Sending this field when the capability is unavailable returns 403. Rejected when true on DROPPED_TO_OFFICE.","uniqueKey":"itemsToReturn.oneOf.0.items.[INDEX].holdRequested.oneOf.1","typeLabel":"null"}],"uniqueKey":"itemsToReturn.oneOf.0.items.[INDEX].holdRequested","typeLabel":"boolean | null"}},"required":["inventoryId"],"uniqueKey":"itemsToReturn.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"itemsToReturn.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"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.","items":{"type":"object","properties":{"inventoryId":{"type":"string","format":"uuid","description":"Inventory ID being returned or dropped off at office."},"returnReasonComment":{"oneOf":[{"type":"string","description":"Optional free-text comment about the return. Only used for ship return types (SHIP_TO_FIRSTBASE, SHIP_TO_OFFICE). Rejected when non-blank on DROPPED_TO_OFFICE.","maxLength":500,"minLength":0},{"type":"null","description":"Optional free-text comment about the return. Only used for ship return types (SHIP_TO_FIRSTBASE, SHIP_TO_OFFICE). Rejected when non-blank on DROPPED_TO_OFFICE.","maxLength":500,"minLength":0}]},"itad":{"oneOf":[{"type":"boolean","description":"Whether to elect ITAD (IT Asset Disposition) for this item. Only used for ship return types. Not allowed for subscription/HaaS items. Rejected when true on DROPPED_TO_OFFICE."},{"type":"null","description":"Whether to elect ITAD (IT Asset Disposition) for this item. Only used for ship return types. Not allowed for subscription/HaaS items. Rejected when true on DROPPED_TO_OFFICE."}]},"holdRequested":{"oneOf":[{"type":"boolean","description":"Whether to request a machine retention hold for this item. Only used for ship return types. Only available when this capability is enabled for your organization. When available and the organization's retention policy for the person's region is AD_HOC, set to true to request a hold. Omitted or null is treated as false. Sending this field when the capability is unavailable returns 403. Rejected when true on DROPPED_TO_OFFICE."},{"type":"null","description":"Whether to request a machine retention hold for this item. Only used for ship return types. Only available when this capability is enabled for your organization. When available and the organization's retention policy for the person's region is AD_HOC, set to true to request a hold. Omitted or null is treated as false. Sending this field when the capability is unavailable returns 403. Rejected when true on DROPPED_TO_OFFICE."}]}},"required":["inventoryId"]},"uniqueKey":"itemsToReturn.oneOf.1","typeLabel":"null"}],"uniqueKey":"itemsToReturn","typeLabel":"object[] | null"},"itemsToNotReturn":{"oneOf":[{"type":"array","description":"Equipment NOT being returned (with deploy reasons). Every eligible inventory item must appear in exactly one of itemsToReturn or itemsToNotReturn.","items":{"type":"object","properties":{"inventoryId":{"type":"string","format":"uuid","description":"Inventory ID NOT being returned.","isRequired":true,"uniqueKey":"itemsToNotReturn.oneOf.0.items.[INDEX].inventoryId","typeLabel":"string\u003cuuid>"},"deployReason":{"type":"string","description":"Reason this item is not being returned.","enum":["ASSIGNED_TO_ADMIN","AWAITING_INFORMATION","BOUGHT_OUT","CANCELLED_BY_FIRSTBASE","CANCELLED_BY_VENDOR","CHURNED_CUSTOMER","DATA_ERROR","DATA_HOLD","DECOMMISSIONED_BY_EMPLOYER","DECOMMISSIONED_BY_FIRSTBASE","END_OF_USEFUL_LIFE_DESTROYED","END_OF_USEFUL_LIFE_DONATED","PENDING_FULFILLMENT","GIFTED_BY_EMPLOYER","GIFTED_BY_FIRSTBASE","IN_TRANSIT","LOCKED_APPLE_ACTIVATION","LOCKED_FMD_REPORTED_LOST_STOLEN","LOCKED_MDM","LOCKED_PIN","LOST_BY_FIRSTBASE","LOST_IN_TRANSIT","LOST_BY_WORKER","MARKED_FOR_DESTRUCTION","NA","NEVER_RECEIVED_BY_WORKER","NEVER_RETURNED_BY_WORKER","OTHER","OUT_FOR_DESTRUCTION","OUT_FOR_REPAIR","PENDING_BUY_OUT","PENDING_HOLD_RELEASE","RECYCLING_REQUESTED","REQUIRES_CLEANING","REQUIRES_REPAIR","RETURN_IN_PROGRESS","SENT_TO_OFFICE","STAGED_FOR_3RD_PARTY","STOLEN","UNRESPONSIVE_WORKER","UNSUPPORTED_REGION","PERSONAL_DEVICE"],"isRequired":true,"uniqueKey":"itemsToNotReturn.oneOf.0.items.[INDEX].deployReason","typeLabel":"enum\u003cstring>"},"deployReasonDetail":{"oneOf":[{"type":"string","description":"Free-text detail. Required when deployReason is OTHER. Maximum 35 characters.","maxLength":35,"minLength":0,"uniqueKey":"itemsToNotReturn.oneOf.0.items.[INDEX].deployReasonDetail.oneOf.0","typeLabel":"string"},{"type":"null","description":"Free-text detail. Required when deployReason is OTHER. Maximum 35 characters.","maxLength":35,"minLength":0,"uniqueKey":"itemsToNotReturn.oneOf.0.items.[INDEX].deployReasonDetail.oneOf.1","typeLabel":"null"}],"uniqueKey":"itemsToNotReturn.oneOf.0.items.[INDEX].deployReasonDetail","typeLabel":"string | null"}},"required":["deployReason","inventoryId"],"uniqueKey":"itemsToNotReturn.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"itemsToNotReturn.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Equipment NOT being returned (with deploy reasons). Every eligible inventory item must appear in exactly one of itemsToReturn or itemsToNotReturn.","items":{"type":"object","properties":{"inventoryId":{"type":"string","format":"uuid","description":"Inventory ID NOT being returned."},"deployReason":{"type":"string","description":"Reason this item is not being returned.","enum":["ASSIGNED_TO_ADMIN","AWAITING_INFORMATION","BOUGHT_OUT","CANCELLED_BY_FIRSTBASE","CANCELLED_BY_VENDOR","CHURNED_CUSTOMER","DATA_ERROR","DATA_HOLD","DECOMMISSIONED_BY_EMPLOYER","DECOMMISSIONED_BY_FIRSTBASE","END_OF_USEFUL_LIFE_DESTROYED","END_OF_USEFUL_LIFE_DONATED","PENDING_FULFILLMENT","GIFTED_BY_EMPLOYER","GIFTED_BY_FIRSTBASE","IN_TRANSIT","LOCKED_APPLE_ACTIVATION","LOCKED_FMD_REPORTED_LOST_STOLEN","LOCKED_MDM","LOCKED_PIN","LOST_BY_FIRSTBASE","LOST_IN_TRANSIT","LOST_BY_WORKER","MARKED_FOR_DESTRUCTION","NA","NEVER_RECEIVED_BY_WORKER","NEVER_RETURNED_BY_WORKER","OTHER","OUT_FOR_DESTRUCTION","OUT_FOR_REPAIR","PENDING_BUY_OUT","PENDING_HOLD_RELEASE","RECYCLING_REQUESTED","REQUIRES_CLEANING","REQUIRES_REPAIR","RETURN_IN_PROGRESS","SENT_TO_OFFICE","STAGED_FOR_3RD_PARTY","STOLEN","UNRESPONSIVE_WORKER","UNSUPPORTED_REGION","PERSONAL_DEVICE"]},"deployReasonDetail":{"oneOf":[{"type":"string","description":"Free-text detail. Required when deployReason is OTHER. Maximum 35 characters.","maxLength":35,"minLength":0},{"type":"null","description":"Free-text detail. Required when deployReason is OTHER. Maximum 35 characters.","maxLength":35,"minLength":0}]}},"required":["deployReason","inventoryId"]},"uniqueKey":"itemsToNotReturn.oneOf.1","typeLabel":"null"}],"uniqueKey":"itemsToNotReturn","typeLabel":"object[] | null"},"address":{"type":"null","properties":{"addressLine1":{"type":"string","description":"Street address line 1","example":"123 Sesame Street"},"addressLine2":{"type":"string","description":"Street address line 2","example":"Suite 103"},"administrativeArea":{"type":"string","description":"the state or county","example":"NY"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code","example":"US"},"locality":{"type":"string","description":"the city","example":"New York City"},"postalCode":{"type":"string","description":"the postal code or zip code","example":"10123"},"phoneNumber":{"oneOf":[{"type":"string","description":"Phone number for the return shipping address. When omitted, the person's existing phone number is preserved.","example":"555-867-5309"},{"type":"null","description":"Phone number for the return shipping address. When omitted, the person's existing phone number is preserved.","example":"555-867-5309"}]}},"required":["countryCode"],"description":"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.","uniqueKey":"address","typeLabel":"null"},"addressValidationNeeded":{"type":"boolean","default":true,"description":"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.","uniqueKey":"addressValidationNeeded","typeLabel":"boolean"}},"required":["personLastDate","returnType"],"uniqueKey":"","typeLabel":"object"},"example":{"address":{"addressLine1":"123 Sesame Street","addressLine2":"Suite 103","administrativeArea":"NY","countryCode":"US","locality":"New York City","postalCode":"10123","phoneNumber":"555-867-5309"}},"examples":{"Example":{"title":"Example","value":{"address":{"addressLine1":"123 Sesame Street","addressLine2":"Suite 103","administrativeArea":"NY","countryCode":"US","locality":"New York City","postalCode":"10123","phoneNumber":"555-867-5309"}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"4e1e2c86-be4e-420e-bde7-7bf38ffc0919":{"description":"OK","content":{"*/*":{"schema":{"type":"object","description":"A person (employee) record in Firstbase","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for this person","example":"e2bd9633-46b4-4286-85bd-3403a3f17e0f","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"role":{"type":"string","description":"Role of this person within the organization (BASIC = standard employee, ADMIN = org admin)","enum":["BASIC","ADMIN"],"example":"BASIC","isRequired":true,"uniqueKey":"role","typeLabel":"enum\u003cstring>"},"firstName":{"type":"string","description":"First name of the person","example":"Jenny","isRequired":true,"uniqueKey":"firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the person","example":"Smith","isRequired":true,"uniqueKey":"lastName","typeLabel":"string"},"status":{"type":"string","description":"Current lifecycle status of the person in Firstbase (e.g. INVITED, ACTIVE, OFFBOARDING)","enum":["INVITED","ACTIVE","INACTIVE","DELETED","OFFBOARDING","CANNOT_REACTIVATE"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"identityEmail":{"type":"string","description":"Identity email address, used for platform login and notifications","example":"jenny@example.com","uniqueKey":"identityEmail","typeLabel":"string"},"email":{"type":"string","description":"Primary email address, used for platform login and notifications","example":"jenny@example.com","uniqueKey":"email","typeLabel":"string"},"secondaryEmail":{"type":"string","description":"Secondary email address; null when not provided","example":"jenny@secondary.example.com","uniqueKey":"secondaryEmail","typeLabel":"string"},"phoneNumber":{"type":"string","description":"Phone number from the person's home address; null when not provided","example":"555-867-5309","uniqueKey":"phoneNumber","typeLabel":"string"},"startDate":{"type":"string","format":"date","description":"Employment start date, used to trigger onboarding timelines","example":"2023-11-22","uniqueKey":"startDate","typeLabel":"string\u003cdate>"},"homeAddress":{"type":"object","properties":{"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code","example":"US","isRequired":true,"uniqueKey":"homeAddress.countryCode","typeLabel":"string"},"addressLine1":{"type":"string","description":"Street address line 1","example":"123 Sesame Street","uniqueKey":"homeAddress.addressLine1","typeLabel":"string"},"addressLine2":{"type":"string","description":"Street address line 2","example":"Suite 103","uniqueKey":"homeAddress.addressLine2","typeLabel":"string"},"administrativeArea":{"type":"string","description":"State, province, or county","example":"NY","uniqueKey":"homeAddress.administrativeArea","typeLabel":"string"},"locality":{"type":"string","description":"City or locality","example":"New York City","uniqueKey":"homeAddress.locality","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal code or ZIP code","example":"10123","uniqueKey":"homeAddress.postalCode","typeLabel":"string"}},"required":["countryCode"],"description":"Home address of the person, used for equipment deliveries","uniqueKey":"homeAddress","typeLabel":"object"},"package":{"type":"object","description":"Equipment package currently assigned to this person; null when no package is assigned","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for this package","example":"3a68a467-8733-4c8d-a942-16ed7ec33018","isRequired":true,"uniqueKey":"package.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Display name of the package","example":"The works","isRequired":true,"uniqueKey":"package.name","typeLabel":"string"},"slug":{"type":"string","description":"URL-safe unique identifier; use it to fetch this package's detail","example":"the-works","isRequired":true,"uniqueKey":"package.slug","typeLabel":"string"},"automaticOrder":{"type":"boolean","description":"When true, an equipment order is placed automatically when a person with this package is onboarded","example":false,"isRequired":true,"uniqueKey":"package.automaticOrder","typeLabel":"boolean"},"approvalRequired":{"type":"boolean","description":"When true, orders from this package require manager approval before being processed","example":false,"isRequired":true,"uniqueKey":"package.approvalRequired","typeLabel":"boolean"},"requireJustification":{"type":"boolean","description":"When true, order items in this package require a justification","example":false,"isRequired":true,"uniqueKey":"package.requireJustification","typeLabel":"boolean"},"active":{"type":"boolean","description":"Whether this package is currently active. Inactive packages cannot be used for new assignments","example":true,"isRequired":true,"uniqueKey":"package.active","typeLabel":"boolean"},"assignedTo":{"type":"object","properties":{"people":{"type":"array","description":"List of people assigned to this package. Each entry contains identifying information for a person linked to this package assignment.","examples":["3cf416c1-1b0f-4344-9cec-ba9c9fe615c9"],"items":{"type":"string","format":"uuid","uniqueKey":"package.assignedTo.people.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"package.assignedTo.people","typeLabel":"string\u003cuuid>[]"}},"description":"People and groups currently assigned to this package","isRequired":true,"uniqueKey":"package.assignedTo","typeLabel":"object"},"skuIds":{"type":"array","description":"List of SKU IDs included in this package; null when no SKUs are configured","examples":["3cf416c1-1b0f-4344-9cec-ba9c9fe615c9"],"items":{"type":"string","format":"uuid","uniqueKey":"package.skuIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"package.skuIds","typeLabel":"string\u003cuuid>[]"}},"required":["active","approvalRequired","assignedTo","automaticOrder","id","name","requireJustification","slug"],"uniqueKey":"package","typeLabel":"object"},"cpfNumber":{"type":"string","description":"Brazilian CPF tax number; null for non-Brazilian employees","example":"87523654789","uniqueKey":"cpfNumber","typeLabel":"string"},"accessLevel":{"type":"string","description":"Platform access level. BASIC is a standard employee, ADMIN is a full org admin, ADMIN_READ_ONLY is a read-only org admin. Omitted when the person has no access level.","enum":["BASIC","ADMIN","ADMIN_READ_ONLY"],"example":"BASIC","readOnly":true,"uniqueKey":"accessLevel","typeLabel":"enum\u003cstring>"},"lastDay":{"type":"string","format":"date","description":"Last working day recorded at offboarding (platform \"Last Day\"), ISO 8601 date. Omitted when the person has no Last Day.","example":"2026-01-31","readOnly":true,"uniqueKey":"lastDay","typeLabel":"string\u003cdate>"}},"required":["firstName","id","lastName","role","status"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"e2bd9633-46b4-4286-85bd-3403a3f17e0f","role":"BASIC","firstName":"Jenny","lastName":"Smith","status":"INVITED","identityEmail":"jenny@example.com","email":"jenny@example.com","secondaryEmail":"jenny@secondary.example.com","phoneNumber":"555-867-5309","startDate":"2023-11-22","homeAddress":{"countryCode":"US","addressLine1":"123 Sesame Street","addressLine2":"Suite 103","administrativeArea":"NY","locality":"New York City","postalCode":"10123"},"package":{"id":"3a68a467-8733-4c8d-a942-16ed7ec33018","name":"The works","slug":"the-works","automaticOrder":false,"approvalRequired":false,"requireJustification":false,"active":true,"assignedTo":{"people":"3cf416c1-1b0f-4344-9cec-ba9c9fe615c9"},"skuIds":"3cf416c1-1b0f-4344-9cec-ba9c9fe615c9"},"cpfNumber":"87523654789","accessLevel":"BASIC","lastDay":"2026-01-31"}}},"exampleType":"generated"}},"exampleType":"generated"},"41541e99-ce3a-48b1-a8e5-ca35582a6680":{"description":"Validation or business rule error. Returns source \"ASSET_TRACKING_ONLY_GEO\" when the destination country or region is configured as asset-tracking-only for shipment return paths (SHIP_TO_FIRSTBASE, SHIP_TO_OFFICE).","content":{"*/*":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"Human-readable description of the error","example":"Invalid request","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"string","description":"Entity or field path that caused the error (for example order, shipmentNotice, or person:email)","example":"request","isRequired":true,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"string"}},"required":["detail","source"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"List of error details.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"detail":"Invalid request","source":"request"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"05b1a229-2b5a-492f-84f7-219349a57fd2":{"description":"Contract tier not available or feature flag disabled","content":{"*/*":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"Human-readable description of the error","example":"Invalid request","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"string","description":"Entity or field path that caused the error (for example order, shipmentNotice, or person:email)","example":"request","isRequired":true,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"string"}},"required":["detail","source"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"List of error details.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"detail":"Invalid request","source":"request"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"5a0dbb17-3fd5-4a15-a400-e4fec52900d3":{"description":"Person not found","content":{"*/*":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"Human-readable description of the error","example":"Invalid request","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"string","description":"Entity or field path that caused the error (for example order, shipmentNotice, or person:email)","example":"request","isRequired":true,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"string"}},"required":["detail","source"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"List of error details.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"detail":"Invalid request","source":"request"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"79ff5ac4-1db1-475c-bee1-9bc27c1b112f":{"description":"Conflict","content":{"*/*":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"Human-readable description of the error","example":"Invalid request","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"string","description":"Entity or field path that caused the error (for example order, shipmentNotice, or person:email)","example":"request","isRequired":true,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"string"}},"required":["detail","source"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"List of error details.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"detail":"Invalid request","source":"request"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1e65b031-3712-4e0e-af72-36a1881b7f28":{"ApiKey":{"type":"apiKey","description":"Prefix the value with \"ApiKey\" to indicate the custom authorization type","name":"Authorization","in":"header","scopes":[],"schemeName":"ApiKey"}}},"servers":{"c72a91e2-ce89-42c6-8eda-72a67db3f3b0":{"url":"https://apipub.firstbasehq.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Prefix the value with \"ApiKey\" to indicate the custom authorization type","name":"Authorization","in":"header","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"Authorization","type":"string","description":"Prefix the value with \"ApiKey\" to indicate the custom authorization type","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"Authorization"}],"title":"ApiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"firstbase-cd088419","siteName":"Firstbase API","title":"Offboard person - Firstbase API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T16:37:07.101Z","originalFileLocation":"api-reference/people/offboard-person.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Starts offboarding for the person. May create return workflows depending on request body options (for example address confirmation and items not to return).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Firstbase API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Offboard person - Firstbase API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Starts offboarding for the person. May create return workflows depending on request body options (for example address confirmation and items not to return).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Firstbase API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.firstbase.com/api-reference/people/offboard-person\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://firstbase-cd088419.mintlify.site/_mintlify/api/og/v2?division=People\u0026amp;title=Offboard+person\u0026amp;description=Starts+offboarding+for+the+person.+May+create+return+workflows+depending+on+request+body+options+%28for+example+address+confirmation+and+items+not+to+return%29.\u0026amp;theme=bfdcc2e7405570affd55a598\u0026amp;signature=418a68b1a9ff4163149bc066fe8ef2e6e0d25486435deb79ca3f6fcd7bfb95cd\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Offboard person - Firstbase API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Starts offboarding for the person. May create return workflows depending on request body options (for example address confirmation and items not to return).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firstbase-cd088419.mintlify.site/_mintlify/api/og/v2?division=People\u0026amp;title=Offboard+person\u0026amp;description=Starts+offboarding+for+the+person.+May+create+return+workflows+depending+on+request+body+options+%28for+example+address+confirmation+and+items+not+to+return%29.\u0026amp;theme=bfdcc2e7405570affd55a598\u0026amp;signature=418a68b1a9ff4163149bc066fe8ef2e6e0d25486435deb79ca3f6fcd7bfb95cd\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Firstbase API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#f2555a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.firstbase.com/api-reference/people/offboard-person\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/people/offboard-person.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.firstbase.com/#organization\",\"name\":\"Firstbase API\",\"url\":\"https://developers.firstbase.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/firstbase-cd088419/DDV5t2EOeCNU8R4K/logo/light.svg?fit=max\u0026auto=format\u0026n=DDV5t2EOeCNU8R4K\u0026q=85\u0026s=e22f02de6760918dfb83ad51b00a4dd8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.firstbase.com#website\",\"name\":\"Firstbase API\",\"url\":\"https://developers.firstbase.com\",\"publisher\":{\"@id\":\"https://developers.firstbase.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.firstbase.com/api-reference/people/offboard-person#webpage\",\"url\":\"https://developers.firstbase.com/api-reference/people/offboard-person\",\"name\":\"Offboard person\",\"description\":\"Starts offboarding for the person. May create return workflows depending on request body options (for example address confirmation and items not to return).\",\"dateModified\":\"2026-11-13T16:37:07.101Z\",\"isPartOf\":{\"@id\":\"https://developers.firstbase.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.firstbase.com/api-reference/people/offboard-person#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.firstbase.com/api-reference/people/offboard-person#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"People\",\"item\":\"https://developers.firstbase.com/api-reference/people/get-person\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Offboard person\",\"item\":\"https://developers.firstbase.com/api-reference/people/offboard-person\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.firstbase.com/api-reference/people/offboard-person#apireference\",\"headline\":\"Offboard person\",\"name\":\"Offboard person\",\"description\":\"Starts offboarding for the person. May create return workflows depending on request body options (for example address confirmation and items not to return).\",\"url\":\"https://developers.firstbase.com/api-reference/people/offboard-person\",\"mainEntityOfPage\":{\"@id\":\"https://developers.firstbase.com/api-reference/people/offboard-person#webpage\"},\"dateModified\":\"2026-11-13T16:37:07.101Z\",\"publisher\":{\"@id\":\"https://developers.firstbase.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.firstbase.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Firstbase API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Firstbase API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/people/offboard-person.md","siteName":"Firstbase API","nav":{"global":{"anchors":[{"anchor":"Getting Started","icon":"rocket","href":"/"},{"anchor":"Swagger UI","icon":"code","href":"https://apipub.firstbasehq.com/swagger-ui/index.html"}]},"groups":[{"group":"Guides","pages":[{"title":"Rate limits","href":"/rate-limits"}]},{"group":"Catalog","pages":[{"title":"List categories","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/categories","href":"/api-reference/catalog/list-categories"},{"title":"Get SKU","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/catalog/skus/{skuId}","href":"/api-reference/catalog/get-sku"},{"title":"List SKUs","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/catalog/skus","href":"/api-reference/catalog/list-skus"},{"title":"List brands","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/brands","href":"/api-reference/catalog/list-brands"}]},{"group":"Inventory","pages":[{"title":"Add tags","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/inventory/{inventoryId}/tags","href":"/api-reference/inventory/add-tags"},{"title":"Create asset","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/assets","href":"/api-reference/inventory/create-asset"},{"title":"Get inventory item","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory/{inventoryId}","href":"/api-reference/inventory/get-inventory-item"},{"title":"Update inventory","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/inventory/{inventoryId}","href":"/api-reference/inventory/update-inventory"},{"title":"List inventory","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory","href":"/api-reference/inventory/list-inventory"},{"title":"Remove tag","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/inventory/{inventoryId}/tags/{tagId}","href":"/api-reference/inventory/remove-tag"}]},{"group":"Inventory Levels","pages":[{"title":"List inventory levels","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory-levels","href":"/api-reference/inventory-levels/list-inventory-levels"},{"title":"Create inventory level","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/inventory-levels","href":"/api-reference/inventory-levels/create-inventory-level"},{"title":"Update inventory level","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/inventory-levels/{id}","href":"/api-reference/inventory-levels/update-inventory-level"},{"title":"Delete inventory level","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/inventory-levels/{id}","href":"/api-reference/inventory-levels/delete-inventory-level"}]},{"group":"Inventory Orders","pages":[{"title":"List inventory orders","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory-orders","href":"/api-reference/inventory-orders/list-inventory-orders"},{"title":"Create inventory order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/inventory-orders","href":"/api-reference/inventory-orders/create-inventory-order"},{"title":"Modify inventory order","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/inventory-orders/{inventoryOrderId}","href":"/api-reference/inventory-orders/modify-inventory-order"},{"title":"Cancel inventory order","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/inventory-orders/{inventoryOrderId}","href":"/api-reference/inventory-orders/cancel-inventory-order"},{"title":"Get inventory order","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory-orders/{id}","href":"/api-reference/inventory-orders/get-inventory-order"}]},{"group":"ITAD","pages":[{"title":"List ITAD requests","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/itad/requests","href":"/api-reference/itad/list-itad-requests"},{"title":"Create ITAD requests","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/itad/requests","href":"/api-reference/itad/create-itad-requests"},{"title":"Get ITAD request","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/itad/requests/{requestId}","href":"/api-reference/itad/get-itad-request"},{"title":"List eligible assets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/itad/eligible-assets","href":"/api-reference/itad/list-eligible-assets"}]},{"group":"New Joiners","pages":[{"title":"Send reminder","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/new-joiners/{personId}/remind","href":"/api-reference/new-joiners/send-reminder"},{"title":"Get new joiner stats","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/new-joiners/stats","href":"/api-reference/new-joiners/get-new-joiner-stats"},{"title":"List new joiners","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/new-joiners","href":"/api-reference/new-joiners/list-new-joiners"}]},{"group":"Offices","pages":[{"title":"Modify office","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/offices/{officeId}","href":"/api-reference/offices/modify-office"},{"title":"Get office","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/offices/{id}","href":"/api-reference/offices/get-office"},{"title":"List offices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/offices","href":"/api-reference/offices/list-offices"}]},{"group":"Orders","pages":[{"title":"Decline an order awaiting approval","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders/{orderId}/decline","href":"/api-reference/orders/decline-an-order-awaiting-approval"},{"title":"Approve order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders/{orderId}/approve","href":"/api-reference/orders/approve-order"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders","href":"/api-reference/orders/list-orders"},{"title":"Create order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders","href":"/api-reference/orders/create-order"},{"title":"Get order","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{orderId}","href":"/api-reference/orders/get-order"},{"title":"Modify or cancel an existing order","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/orders/{orderId}","href":"/api-reference/orders/modify-or-cancel-an-existing-order"}]},{"group":"Packages","pages":[{"title":"Duplicate an existing package","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/packages/{slug}/duplicate","href":"/api-reference/packages/duplicate-an-existing-package"},{"title":"List packages","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/packages","href":"/api-reference/packages/list-packages"},{"title":"Create package","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/packages","href":"/api-reference/packages/create-package"},{"title":"Modify package note","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/packages/{slug}/notes/{noteId}","href":"/api-reference/packages/modify-package-note"},{"title":"Get package","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/packages/{slug}","href":"/api-reference/packages/get-package"},{"title":"Modify package","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/packages/{slug}","href":"/api-reference/packages/modify-package"}]},{"group":"People","pages":[{"title":"Get person","deprecated":null,"version":null,"openapi":"/openapi.json get /scim/v2/Users/{id}","href":"/api-reference/people/get-person"},{"title":"Replace person","deprecated":null,"version":null,"openapi":"/openapi.json put /scim/v2/Users/{id}","href":"/api-reference/people/replace-person"},{"title":"Delete user","deprecated":null,"version":null,"openapi":"/openapi.json delete /scim/v2/Users/{id}","href":"/api-reference/people/delete-user"},{"title":"List people","deprecated":null,"version":null,"openapi":"/openapi.json get /scim/v2/Users","href":"/api-reference/people/list-people"},{"title":"Create person","deprecated":null,"version":null,"openapi":"/openapi.json post /scim/v2/Users","href":"/api-reference/people/create-person"},{"title":"Bulk upsert users","deprecated":null,"version":null,"openapi":"/openapi.json post /scim/v2/Users/csv","href":"/api-reference/people/bulk-upsert-users"},{"title":"Bulk operations","deprecated":null,"version":null,"openapi":"/openapi.json post /scim/v2/Bulk","href":"/api-reference/people/bulk-operations"},{"title":"Reactivate person","description":"Reactivates a previously offboarded person in the caller's organization. Restores the person for ordering and inventory assignment according to current organization settings.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/people/{personId}/reactivate","href":"/api-reference/people/reactivate-person"},{"title":"Offboard person","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/people/{personId}/offboard","href":"/api-reference/people/offboard-person"},{"title":"Send email","description":"Triggers an admin email action for the specified person. The `emailType` determines the action:\n\n- **RESEND_ACTIVATION** — Resends the activation email to a person with INVITED status who has a platform account.\n- **RESEND_OFFBOARDING** — Resends the arrange-return / offboarding email to a person who is currently being offboarded (OFFBOARDING status).\n- **SEND_PLATFORM_INVITE** — Sends a platform access invite email to an ACTIVE person who does not yet have platform access. Creates a platform account and sets the person's status to INVITED.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/people/{personId}/emails","href":"/api-reference/people/send-email"}]},{"group":"Regions","pages":[{"title":"List regions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/regions","href":"/api-reference/regions/list-regions"},{"title":"Get region","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/regions/{id}","href":"/api-reference/regions/get-region"}]},{"group":"Replacements","pages":[{"title":"List replacements","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/replacements","href":"/api-reference/replacements/list-replacements"},{"title":"Create replacement","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/replacements","href":"/api-reference/replacements/create-replacement"},{"title":"Get replacement","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/replacements/{id}","href":"/api-reference/replacements/get-replacement"},{"title":"Cancel replacement","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/replacements/{replacementId}","href":"/api-reference/replacements/cancel-replacement"}]},{"group":"Returns","pages":[{"title":"List returns","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/returns","href":"/api-reference/returns/list-returns"},{"title":"Create return","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/returns","href":"/api-reference/returns/create-return"},{"title":"Process return items","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/return-orders/{returnOrderId}/items","href":"/api-reference/returns/process-return-items"},{"title":"Get return","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/returns/{id}","href":"/api-reference/returns/get-return"},{"title":"Cancel return","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/return-orders/{returnOrderId}","href":"/api-reference/returns/cancel-return"}]},{"group":"Shipment","pages":[{"title":"Get shipment","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/shipments","href":"/api-reference/shipment/get-shipment"},{"title":"List carriers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/carriers","href":"/api-reference/shipment/list-carriers"}]},{"group":"Shipment Notices","pages":[{"title":"List shipment notices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/shipment-notices","href":"/api-reference/shipment-notices/list-shipment-notices"},{"title":"Create shipment notice","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/shipment-notices","href":"/api-reference/shipment-notices/create-shipment-notice"},{"title":"Modify shipment notice","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/shipment-notices/{shipmentNoticeId}","href":"/api-reference/shipment-notices/modify-shipment-notice"},{"title":"Cancel shipment notice","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/shipment-notices/{shipmentNoticeId}","href":"/api-reference/shipment-notices/cancel-shipment-notice"},{"title":"Get shipment notice","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/shipment-notices/{id}","href":"/api-reference/shipment-notices/get-shipment-notice"}]},{"group":"Warehouses","pages":[{"title":"List warehouses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/warehouses","href":"/api-reference/warehouses/list-warehouses"},{"title":"Get warehouse","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/warehouses/{id}","href":"/api-reference/warehouses/get-warehouse"}]}]},"basePath":"","title":"Offboard person - Firstbase API","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}