Get Employee | Deel. PayAndBill API Documentation

curl -G https://{{baseurl}}/employees \
     -H "Authorization: Bearer <token>" \
     -d userUuid=axgZDy2kxi6mbvC9sNDL5dMs \
     --data-urlencode include=personalDetails.nameFirst,personalDetails.nameLast,engagement

{
  "personalDetails": {
    "uuid": "string",
    "nameTitle": "Mr",
    "nameFirst": "John",
    "nameLast": "Doe",
    "nameMiddle": "string",
    "nameKnownAs": "string",
    "dateOfBirth": "1990-01-01",
    "gender": "Male",
    "maritalStatus": "Single",
    "contact": {
      "primaryEmail": "john.doe@example.com",
      "payslipEmail": "string",
      "phone": {
        "countryCode": "44",
        "number": "7700123456"
      },
      "mobile": {
        "countryCode": "44",
        "number": "7700123456"
      }
    },
    "postalAddress": {
      "line1": "string",
      "line2": "string",
      "townCity": "string",
      "country": "string",
      "foreignCountry": "string",
      "postcode": "string",
      "state": "string"
    },
    "emergencyContact": {
      "fullName": "string",
      "email": "string",
      "relationship": "string",
      "phone": {
        "countryCode": "44",
        "number": "7700123456"
      }
    }
  },
  "engagement": [
    {
      "uuid": "string",
      "payrollCompanyId": "string",
      "payCycleId": "string",
      "permissionGroup": "Full Time",
      "payType": "PAYE",
      "engagementType": "Full Time",
      "startDate": "2026-11-01",
      "terminationDate": "2023-01-15",
      "terminationReason": "string",
      "job": [
        {
          "uuid": "string",
          "customerId": "68b527c6-b331-453e-a06f-cab8d9bc1ccf",
          "enableLeave": true,
          "enableExpenses": true,
          "payFrequency": "Weekly",
          "workplace": {
            "name": "HQ",
            "address": {
              "line1": "string",
              "line2": "string",
              "townCity": "string",
              "country": "string",
              "foreignCountry": "string",
              "postcode": "string",
              "state": "string"
            }
          },
          "startDate": "2026-11-02",
          "finishDate": "2023-01-15",
          "payRate": "string",
          "payRateCurrency": "GBP",
          "payRateInterval": "Hourly",
          "payMultiplier": "string",
          "primaryApprover": "string",
          "secondaryApprover": "string",
          "expenseApprover": "string",
          "recruiter": "string",
          "timesheetStartDate": "2026-11-02",
          "timesheetType": "Hourly",
          "timesheetEnable": true,
          "fixedPayItems": true,
          "timesheetLength": "Weekly",
          "variableTimesheet": true,
          "splitShifts": true,
          "timesheetForPayroll": true,
          "timesheetStart": "2",
          "rateCard": "string",
          "ruleGroup": "string",
          "billingGroupUuid": "string",
          "glGroupUuid": "string",
          "timeSheetPayRate": {
            "onCost": "3.2000",
            "chargeCost": "35.0000"
          }
        }
      ]
    }
  ],
  "externalIdMapping": {
    "externalId": "string"
  }
}

Retrieve a single employee by their user id.

Authentication

AuthorizationBearer

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

Query parameters

userUuidstringRequired

User id of the employee (not a UUID).

includestringOptional

Comma-separated field paths to return. Nested object paths work (personalDetails.contact.primaryEmail); an array can only be returned whole (engagement). A path into an array, such as engagement.job.payRate, is not supported and returns the full response.

Response

Successful Response

personalDetailsobjectOptional

engagementlist of objectsOptional

externalIdMappingobjectOptional

Errors

400

Bad Request Error

404

Not Found Error

Authentication

Headers

Query parameters

Response

Errors