Get Employee | Deel. PayAndBill API Documentation

curl -G https://{{baseurl}}/employees \
     -H "Authorization: Bearer <token>" \
     -d userUuid=a3b3d8a6-49bc-4b68-9745-16818eaf20b5 \
     --data-urlencode include=personalDetails.nameFirst,personalDetails.nameLast,engagement.job.payRate

{
  "id": 1000,
  "userUuid": "rcjJX5K6v5XzoyNVWqHXS6",
  "remoteId": 55,
  "remoteSource": "classic",
  "isLocked": false,
  "personalDetails": {
    "uuid": "502519de-0287-4bb8-a3f1-d269eb850086",
    "userUuid": "rcjJX5K6v5XzoyNVWqHXS6",
    "nameInitials": "JD",
    "nameTitle": "Mr",
    "nameFirst": "John",
    "nameLast": "Doe",
    "nameMiddle": "A",
    "nameKnownAs": "Johnny",
    "dateOfBirth": "1990-01-15",
    "gender": "Male",
    "maritalStatus": "Single",
    "contact": {
      "primaryEmail": "john.doe@example.com",
      "payslipEmail": "john.doe.payslip@example.com",
      "phoneNumber": "+441234567890",
      "mobileNumber": "+447700123456",
      "emailPayslip": true,
      "sendNotification": true
    },
    "postalAddress": {},
    "emergencyContact": {},
    "remoteId": 55,
    "remoteSource": "classic",
    "nationality": "British"
  },
  "engagement": [
    {
      "uuid": "8a4f3e2d-1b2c-3d4e-5f6a-7b8c9d0e1f2a",
      "payrollCompanyId": "1",
      "payType": "PAYE",
      "engagementType": "Full Time",
      "startDate": "2024-01-15",
      "terminationDate": "2023-01-15",
      "status": "ACTIVE",
      "hoursNormallyWorked": "MoreThan30",
      "remoteId": 101,
      "remoteSource": "classic",
      "job": [
        {}
      ]
    }
  ],
  "bank": {
    "uuid": "string",
    "accountName": "John Doe",
    "sortCode": "123456",
    "accountNumber": "12345678",
    "bankReference": "string",
    "buildingSocietyNumber": "string"
  },
  "tax_information": {
    "uuid": "string",
    "nationalInsuranceNumber": "AB123456C",
    "niTable": "A",
    "director": true,
    "week1Month1": true,
    "taxCode": "1257L",
    "haveP45Form": true,
    "haveStudentLoan": true,
    "studentLoanType": "None",
    "havePostGradLoan": true,
    "employeeDeclaration": "A",
    "taxInfoType": "TAX_CODE",
    "p45DemoLink": "string"
  },
  "lastSyncStatus": {
    "JOB": "synced",
    "TAX": "synced"
  },
  "employeeStatus": 1,
  "employeeState": "active",
  "externalEmployeeNumber": "string"
}

Retrieve a single employee by their user UUID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

userUuidstringRequiredformat: "uuid"

UUID of the employee's user account.

includestringOptional

Comma-separated field paths to include in the response (e.g. personalDetails.nameFirst,engagement.job.payRate).

Response

Successful Response

idintegerOptional

Internal employee ID

userUuidstringOptional

remoteIdintegerOptional

remoteSourcestringOptional

isLockedbooleanOptional

Whether the employee account is locked

personalDetailsobjectOptional

engagementlist of objectsOptional

bankobjectOptional

tax_informationobjectOptional

Tax and payroll information for the active engagement

lastSyncStatusobjectOptional

Sync status per category (e.g. JOB, TAX, BANK, EMPLOYEE)

employeeStatusintegerOptional

Numeric employee status code

employeeStateenumOptional

externalEmployeeNumberstringOptional

External employee number from integration (e.g. PaySpace)

Errors

400

Bad Request Error

404

Not Found Error

Authentication

Headers

Query parameters

Response

Errors