/departments/{id}

Returns a Department object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

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

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.

namestring or null

The department's name.

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

1	import { MergeClient } from "@mergeapi/merge-node-client";
2
3	const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
4	await client.ats.departments.retrieve("id", {
5	includeRemoteData: true,
6	includeShellData: true
7	});

1	{
2	"id": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
3	"remote_id": "23456",
4	"created_at": "2021-09-15T00:00:00Z",
5	"modified_at": "2021-10-16T00:00:00Z",
6	"name": "Engineering",
7	"remote_was_deleted": true,
8	"field_mappings": {
9	"organization_defined_targets": {
10	"custom_key": "custom_value"
11	},
12	"linked_account_defined_targets": {
13	"custom_key": "custom_value"
14	}
15	},
16	"remote_data": [
17	{
18	"path": "/departments"
19	}
20	]
21	}