Get Employee Directory

🚧
Avoid this common pitfall
The Company Directory is a feature that can be managed and even disabled by each company in their account settings. Because of this, calling this endpoint may perform differently or not at all (if the feature is disabled) from one company to the next. Instead, we recommend integrators use the request a custom report API to retrieve bulk employee data.

Sample Response

{
    "fields": [
        {
            "id": "displayName",
            "type": "text",
            "name": "Display Name"
        },
        {
            "id": "firstName",
            "type": "text",
            "name": "First Name"
        },
        {
            "id": "lastName",
            "type": "text",
            "name": "Last Name"
        },
        {
            "id": "gender",
            "type": "text",
            "name": "Gender"
        },
        {
            "id": "jobTitle",
            "type": "list",
            "name": "Job Title"
        },
        {
            "id": "workPhone",
            "type": "text",
            "name": "Work Phone"
        },
        {
            "id": "workPhoneExtension",
            "type": "text",
            "name": "Work Extension"
        },
        {
            "id": "skypeUsername",
            "type": "text",
            "name": "Skype Username"
        },
        {
            "id": "facebook",
            "type": "text",
            "name": "Facebook URL"
        }
    ],
    "employees": [
        {
            "id":123,
            "displayName":"John Doe",
            "firstName":"John",
            "lastName":"Doe",
            "gender":"Male",
            "jobTitle":"Customer Service Representative",
            "workPhone":"555-555-5555",
            "workPhoneExtension":null,
            "skypeUsername":"JohnDoe",
            "facebook":"JohnDoeFacebook"
        }
    ]
}

<directory>
    <fieldset>
        <field id="displayName">Display name</field>
        <field id="firstName">First name</field>
        <field id="lastName">Last name</field>
        <field id="gender">Gender</field>
        <field id="jobTitle">Job title</field>
        <field id="workPhone">Work Phone</field>
        <field id="workPhoneExtension">Work Extension</field>
        <field id="skypeUsername">Skype Username</field>
        <field id="facebook">Facebook URL</field>
    </fieldset>
    <employees>
        <employee id="123">
            <field id="displayName">John Doe</field>
            <field id="firstName">John</field>
            <field id="lastName">Doe</field>
            <field id="gender">Male</field>
            <field id="jobTitle">Customer Service Representative</field>
            <field id="workPhone">555-555-5555</field>
            <field id="workPhoneExtension"/>
            <field id="skypeUsername">JohnDoe</field>
            <field id="facebook">JohnDoeFacebook</field>
        </employee>
    </employees>
</directory>

🚧Avoid this common pitfall

🚧
Avoid this common pitfall