Get staff information
GET /api/staff_info
Gets staff information using the user IDs in your system (external ID). You can retrieve information for a single staff or multiple staff.
Request
Query parameters
customer_id string Required
The unique Marco identifier for your company.
customer_system_id array[string] Required
The staff's user IDs in your company's system.
Example: [49,50]
customer_system_id_type string Required
The name of your system.
Example: PS
Example Requests
Response (200)
A successful response will return an array of objects, with each object containing each staff's information.
name string
The staff's full name.
role string
The staff's role in Marco.
Valid values: Staff, Manager, Manager & Staff, Intern
system_email string
The staff's email, used to log into Marco.
id integer
The staff's unique identifier in Marco.
country string
The staff's current country, stored as an ISO Alpha-2 code.
status string
The staff's job status.
Valid values: Inactive, Onboarding, Probation, Regular, Offboarded
offboarding_reason string
The staff's offboarding reason.
Valid values: Involuntary, Voluntary.
{address} object
The staff's home address.
{address}.city string
The city name for the staff's home address.
{address}.address1 string
The first address line for the staff's home address.
{address}.address2 string
The second address line for the staff's home address.
{address}.address3 string
The third address line for the staff's home address.
birthdate string
The staff's date of birth, stored as YYYY-MM-DD.
gender string
The staff's gender.
highest_education string
The staff's highest education.
nationality string
The staff's nationality, stored as the country's ISO Alpha-2 code.
personal_email string
The staff's personal email.
phone string
The staff's phone number.
emergency_name string
The name of the staff's emergency contact.
emergency_email string
The email belonging to the staff's emergency contact.
emergency_phone string
The phone number belonging to the staff's emergency contact.
emergency_relationship string
The staff's relationship to the emergency contact.
passport_number string
The staff's passport number.
passport_issue_date string
The staff's passport issue date.
passport_issuing_country string
The staff's passport issuing country, stored as an ISO Alpha-2 code.
passport_expiry_date string
The staff's passport expiry date.
reporting_officer string
The staff's reporting manager.
job_title string
The staff's job title.
location string
The staff's work location.
staff_type string
The staff's service type.
Valid values: System, Payroll, HRO, EOR
work_email string
The staff's work email.
ec_entity string
The business entity that holds the employment relationship with the staff.
ec_type string
The staff's employment contract type.
Valid values: Fixed-term, Indefinite
ec_vendor string
The vendor that employs the staff. Applies to EOR staff only.
job_start_date string
The staff's job start date.
probation_end_date string
The staff's probation end date.
ec_start_date string
The start date for the staff's employment contract. This may differ from the job start date if multiple contracts have been signed in succession.
ec_end_date string
The end date for the staff's employment contract.
last_working_day string
The staff's last working day.
host_country string
The staff's host country, stored as an ISO Alpha-2 code. Applies to Expat staff only.
host_staff_type string
The staff's service type in the host country. Applies to Expat staff only.
host_ec_entity string
The business entity that holds the employment relationship with the staff in the host country. Applies to Expat staff only.
host_ec_vendor string
The vendor that employs the staff in the host country. Applies to EOR Expat staff only.
host_ec_type string
The staff's employment contract type in the host country. Applies to Expat staff only.
Valid values: Fixed-term, Indefinite
host_ec_start_date string
The start date for the staff's employment contract in the host country. Applies to Expat staff only.
host_ec_end_date string
The end date for the staff's employment contract in the host country. Applies to Expat staff only.
job_scope string
The job scope for the staff.
customer_system_id string
The staff's user ID in your company's system.