View employee information

The QuickBooks Payroll API provides resources for viewing employee information. The information below describes how to view employee information. For details, see WorkerManagement_Employee in the GraphQL Reference.

Read employee information

Scope: qb.employee.read

Request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
  query EmployeesQuery($orderBy: [WorkerManagement_EmployeeConnectionOrderBy!]
      $filter: WorkerManagement_EmployeeConnectionFilter!)
  {
      workerManagementEmployees(orderBy: $orderBy, filter: $filter) {
          edges {
            node {
              id
              firstName
              middleName
              lastName
              gender
              alternateIds {
                id
                nameSpace
              }
              employmentStatus {
                active
                detailedStatus
              }
              payrollEmployeeDetails {
                paySchedule {
                  name
                  frequency
                  referenceDates {
                    ... on Payroll_PayScheduleAbsoluteReferenceDates {
                      initialPayDate
                    }
                  }
                }
              }
              contactInfo {
                primaryAddress {
                  city
                  country
                  postalCode
                  state
                  streetAddressLine1
                  streetAddressLine2
                  streetAddressLine3
                }
                primaryEmailAddress {
                  email
                }
                primaryPhoneNumber {
                  number
                  originalNumber
                }
              }
              employmentDetail {
                hireDate
                jobTitle
                terminationDate
              }
              payrollEmployeeDetails {
               workLocation {
                  addressComponents {
                    city
                    country
                    postalCode
                    state
                    streetAddressLine1
                    streetAddressLine2
                    streetAddressLine3
                  }
                }
              }
            }
          }
          pageInfo {
            endCursor
            hasNextPage
            hasPreviousPage
            startCursor
          }
          totalCount
        }
      }

Input variable

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
  {
   "orderBy": [
      "FIRSTNAME_ASC",
      "EMPLOYMENTDETAIL_HIREDATE_ASC"
  ],
  "filter": {
     "employeeId": {
       "in": ["1"]
  }
      "employmentStatus": {
          "active": {
          "eq": true
          }
        }
      }
  }

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
  {
    "data": {
      "workerManagementEmployees": {
        "edges": [
          {
            "node": {
              "id": "1",
              "firstName": "first",
              "middleName": "null",
              "lastName": "One",
              "gender": "null",
              "alternateIds": [
                {
                  "id":    "djQuMTo5MTMwMzU3NTQxODMxOTc2OjlkNjk5ZTk2MDg:1",
                  "nameSpace": "Intuit.sbseg.v4"
                }
              ],
              "employmentStatus": {
                "active": true,
                "detailedStatus": "ACTIVE"
              },
              "payrollEmployeeDetails": {
                "paySchedule": {
                    "name": "Every Friday",
                    "frequency": "EVERY_WEEK",
                    "referenceDates": [
                      {
                        "initialPayDate": "2024-06-14T00:00:00.000Z"
                      }
                    ]
                  },
                  "workLocation": {
                    "addressComponents": {
                      "city": "Mountain View",
                      "country": null,
                      "postalCode": "94043",
                      "state": "CA",
                      "streetAddressLine1": "123 Marine Street",
                      "streetAddressLine2": null,
                      "streetAddressLine3": null
                    }
                  }
                },
              "contactInfo": {
                "primaryAddress": {
                  "city": "Mountain View",
                  "country": "USA",
                  "postalCode": "94043-4802",
                  "state": "CA",
                  "streetAddressLine1": "123 Hope Ave",
                  "streetAddressLine2": null,
                  "streetAddressLine3": null
                },
                "primaryEmailAddress": null,
                "primaryPhoneNumber": null
              },
              "employmentDetail": {
                "hireDate": "2024-06-01",
                "jobTitle": null,
                "terminationDate": null
              },
            }
          }
         ],
        "pageInfo": {
          "endCursor": "0",
          "hasNextPage": false,
          "hasPreviousPage": false,
          "startCursor": "0"
        },
        "totalCount": 1
      }
    }
  }