/employees/{id}

Returns an Employee object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

Allowed values:

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

statusenum

The employee’s status in the accounting system.

ACTIVE - ACTIVE
INACTIVE - INACTIVE

The employee's status in the accounting system. * `ACTIVE` - ACTIVE * `INACTIVE` - INACTIVE

Allowed values:

idstring or nullRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only

The datetime that this object was created by Merge.

modified_atdatetime or nullRead-only

The datetime that this object was modified by Merge.

first_namestring or null<=255 characters

The employee's first name.

last_namestring or null<=255 characters

The employee's last name.

is_contractorboolean or null

True if the employee is a contractor, False if not.

employee_numberstring or null<=50 characters

The employee's internal identification number.

email_addressstring or null

The employee's email address.

companystring or nullformat: "uuid"

The subsidiary that the employee belongs to.

remote_was_deletedboolean or nullRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullRead-only

remote_datalist of objects or nullRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=255 characters

The employee's first name.

last_namestring or nullOptional<=255 characters

The employee's last name.

employee_numberstring or nullOptional<=50 characters

The employee's internal identification number.

email_addressstring or nullOptional

The employee's email address.

companystring or nullOptionalformat: "uuid"

The subsidiary that the employee belongs to.

statusenumOptional

The employee’s status in the accounting system.

ACTIVE - ACTIVE
INACTIVE - INACTIVE

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=255 characters

The employee's first name.

last_namestring or nullOptional<=255 characters

The employee's last name.

is_contractorboolean or nullOptional

True if the employee is a contractor, False if not.

employee_numberstring or nullOptional<=50 characters

The employee's internal identification number.

email_addressstring or nullOptional

The employee's email address.

companystring or nullOptionalformat: "uuid"

The subsidiary that the employee belongs to.

statusenumOptional

The employee’s status in the accounting system.

ACTIVE - ACTIVE
INACTIVE - INACTIVE

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=255 characters

The employee's first name.

last_namestring or nullOptional<=255 characters

The employee's last name.

is_contractorboolean or nullOptional

True if the employee is a contractor, False if not.

employee_numberstring or nullOptional<=50 characters

The employee's internal identification number.

email_addressstring or nullOptional

The employee's email address.

statusenumOptional

The employee’s status in the accounting system.

ACTIVE - ACTIVE
INACTIVE - INACTIVE

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=255 characters

The employee's first name.

last_namestring or nullOptional<=255 characters

The employee's last name.

is_contractorboolean or nullOptional

True if the employee is a contractor, False if not.

employee_numberstring or nullOptional<=50 characters

The employee's internal identification number.

email_addressstring or nullOptional

The employee's email address.

companystring or nullOptionalformat: "uuid"

The subsidiary that the employee belongs to.

statusenumOptional

The employee’s status in the accounting system.

ACTIVE - ACTIVE
INACTIVE - INACTIVE

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=255 characters

The employee's first name.

last_namestring or nullOptional<=255 characters

The employee's last name.

employee_numberstring or nullOptional<=50 characters

The employee's internal identification number.

email_addressstring or nullOptional

The employee's email address.

companystring or nullOptionalformat: "uuid"

The subsidiary that the employee belongs to.

statusenumOptional

The employee’s status in the accounting system.

ACTIVE - ACTIVE
INACTIVE - INACTIVE

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=255 characters

The employee's first name.

last_namestring or nullOptional<=255 characters

The employee's last name.

is_contractorboolean or nullOptional

True if the employee is a contractor, False if not.

employee_numberstring or nullOptional<=50 characters

The employee's internal identification number.

email_addressstring or nullOptional

The employee's email address.

companystring or nullOptionalformat: "uuid"

The subsidiary that the employee belongs to.

statusenumOptional

The employee’s status in the accounting system.

ACTIVE - ACTIVE
INACTIVE - INACTIVE

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=255 characters

The employee's first name.

last_namestring or nullOptional<=255 characters

The employee's last name.

is_contractorboolean or nullOptional

True if the employee is a contractor, False if not.

employee_numberstring or nullOptional<=50 characters

The employee's internal identification number.

email_addressstring or nullOptional

The employee's email address.

statusenumOptional

The employee’s status in the accounting system.

ACTIVE - ACTIVE
INACTIVE - INACTIVE

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=255 characters

The employee's first name.

last_namestring or nullOptional<=255 characters

The employee's last name.

is_contractorboolean or nullOptional

True if the employee is a contractor, False if not.

employee_numberstring or nullOptional<=50 characters

The employee's internal identification number.

email_addressstring or nullOptional

The employee's email address.

companystring or nullOptionalformat: "uuid"

The subsidiary that the employee belongs to.

statusenumOptional

The employee’s status in the accounting system.

ACTIVE - ACTIVE
INACTIVE - INACTIVE

Allowed values:

remote_datalist of objects or nullOptionalRead-only

1	curl -G https://api.merge.dev/api/accounting/v1/employees/id \
2	-H "X-Account-Token: X-Account-Token" \
3	-H "Authorization: Bearer <token>" \
4	-d expand=company

1	{
2	"status": "ACTIVE",
3	"id": "c640b80b-fac9-409f-aa19-1f9221aec445",
4	"remote_id": "11167",
5	"created_at": "2021-09-15T00:00:00Z",
6	"modified_at": "2021-10-16T00:00:00Z",
7	"first_name": "John",
8	"last_name": "Smith",
9	"is_contractor": true,
10	"employee_number": "325462",
11	"email_address": "johnsmith@merge.dev",
12	"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
13	"remote_was_deleted": true,
14	"field_mappings": {
15	"organization_defined_targets": {
16	"custom_key": "custom_value"
17	},
18	"linked_account_defined_targets": {
19	"custom_key": "custom_value"
20	}
21	},
22	"remote_data": [
23	{
24	"path": "/actions"
25	}
26	]
27	}

/employees/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration

Field support by integration