---
title: The user object
slug: api/user-object
description: API reference for the user object.
docTags: 
createdAt: 2023-11-30T03:40:16.387Z
---

Represents a staff's information. The user object is returned by the create or update user information endpoints.



**Object parameters**

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**name** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's full name.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**role** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's role in Marco.

Valid values: Staff, Manager, Manager & Staff, Intern
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**system\_email** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's email, used to log into Marco.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**id** <font color="#a7b4c3">integer</font>
:::

:::VerticalSplitItem
The staff's unique identifier in Marco.

Example: 99
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**country** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's current country, stored as an [ISO Alpha-2 code](https://www.iban.com/country-codes).

Example: JP
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**status** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's job status.

Valid values: Inactive, Onboarding, Probation, Regular, Offboarded
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**offboarding\_reason** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's offboarding reason.

Valid values: Involuntary, Voluntary
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**birthdate** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's date of birth, stored as YYYY-MM-DD.

Example: 1980-01-31
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**gender** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's gender.

Valid values: Female, Male
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**highest\_education** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's highest education.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**nationality** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's nationality, stored as the country's [ISO Alpha-2 code](https://www.iban.com/country-codes).
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**personal\_email** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's personal email.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**phone** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's phone number. Includes the country code.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**emergency\_name** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The name of the staff's emergency contact.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**emergency\_email** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The email belonging to the staff's emergency contact.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**emergency\_phone** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The phone number belonging to the staff's emergency contact. Includes the country code.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**emergency\_relationship** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's relationship to the emergency contact.

Example: Husband
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**passport\_number** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's passport number.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**passport\_issue\_date** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's passport issue date, stored as YYYY-MM-DD.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**passport\_issuing\_country** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's passport issuing country, stored as an [ISO Alpha-2 code](https://www.iban.com/country-codes).
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**passport\_expiry\_date** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's passport expiry date, stored as YYYY-MM-DD.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**reporting\_officer** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's reporting manager.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**job\_title** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's job title.

Example: HR Manager
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**location** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's work location.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**staff\_type** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's service type.

Valid values: System, Payroll, HRO, EOR
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**work\_email** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's work email.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**ec\_entity** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The business entity that holds the employment relationship with the staff.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**ec\_type** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's employment contract type.

Valid values: Fixed-term, Indefinite
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**ec\_vendor** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The vendor that employs the staff. Applies to EOR staff only.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**job\_start\_date** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's job start date, stored as YYYY-MM-DD.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**probation\_end\_date** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's probation end date, stored as YYYY-MM-DD.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**ec\_start\_date** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The start date for the staff's employment contract, stored as YYYY-MM-DD. This may differ from the job start date if multiple contracts have been signed in succession.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**ec\_end\_date** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The end date for the staff's employment contract, stored as YYYY-MM-DD.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**last\_working\_day** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's last working day, stored as YYYY-MM-DD.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**host\_country** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's host country, stored as an [ISO Alpha-2 code](https://www.iban.com/country-codes). Applies to Expat staff only.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**host\_staff\_type** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's service type in the host country. Applies to Expat staff only.

Valid values: System, Payroll, HRO, EOR
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**host\_ec\_entity** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The business entity that holds the employment relationship with the staff in the host country. Applies to Expat staff only.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**host\_ec\_vendor** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The vendor that employs the staff in the host country. Applies to Expat EOR staff only.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**host\_ec\_type** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's employment contract type in the host country. Applies to Expat staff only.

Valid values: Fixed-term, Indefinite
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**host\_ec\_start\_date** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The start date for the staff's employment contract in the host country, stored as YYYY-MM-DD. Applies to Expat staff only.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**host\_ec\_end\_date** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The end date for the staff's employment contract in the host country, stored as YYYY-MM-DD. Applies to Expat staff only.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**job\_scope** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The job scope for the staff.
:::
::::

***

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**customer\_system\_id** <font color="#a7b4c3">string</font>
:::

:::VerticalSplitItem
The staff's unique identifier in your company's system.
:::
::::

***



**Example**

***

:::CodeblockTabs
The user object

```json
{
  "name": "Li Lei",
  "role": "Staff",
  "system_email": "lilei@mail.com",
  "id": 1348,
  "country": "CN",
  "status": "Regular",
  "offboarding_reason": "",
  "birthdate": "",
  "gender": "Male",
  "highest_education": "University",
  "nationality": "CN",
  "personal_email": "ll@mail.com",
  "phone": "8617623453456",
  "emergency_name": "Han Meimei",
  "emergency_email": "hmm@mail.com",
  "emergency_phone": "8618876546789",
  "emergency_relationship": "Mother",
  "passport_number": "EG8213789",
  "passpost_issue_date": "",
  "passport_issuing_country": "",
  "passport_expiry_date": "",
  "reporting_officer": "Tuan Tuan",
  "job_title": "Product Manager",
  "location": "Beijing",
  "staff_type": "Payroll",
  "work_email": "lilei@mail.com",
  "ec_entity": "",
  "ec_type": "Fixed-term",
  "ec_vendor": "",
  "job_start_date": "2020-01-31",
  "probation_end_date": "2020-07-01",
  "ec_start_date": "2020-01-31",
  "ec_end_date": "2025-07-01",
  "last_working_day": null,
  "host_country": "",
  "host_staff_type": "",
  "host_ec_entity": "",
  "host_ec_vendor": "",
  "host_ec_type": "",
  "host_ec_start_date": "",
  "host_ec_end_date": "",
  "job_scope": "",
  "customer_system_id": "50",
},
```
:::











