v1

latestOpenAPI 3.1.02026-08-062713899.5 KB

Users

Get user business info

This endpoint gets user business info by user ID.

get/v2/users/{userId}/business-info

Response

designationstring

emailstring email

employeeIdstring

Unique employee id. Can use email if a company don't use employee ids.

countryCodestring

alpha-2 or alpha-3 ISO country code.

workerType'EMPLOYEE' | 'CONTINGENT' | 'SEASONAL' | 'INTERN' | 'GUEST'

The type of worker.

accountingCodestring

Code used for accounting.

authorizerEmailstring

Email address to be used as approval authorizer, when a manager is not present.

Example response

{
  "departmentRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "designation": "MANAGER",
  "email": "user@business.com",
  "employeeId": "101",
  "gradeRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "legalEntityRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "managerRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "officeRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "organizationRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "phoneNumbers": [
    {
      "countryCode": 91,
      "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
      "extension": "222",
      "isoCountryCode": "IN",
      "italianLeadingZero": true,
      "nationalNumber": 8150,
      "numberOfLeadingZeros": 1,
      "preferredDomesticCarrierCode": "7",
      "rawInput": "77777",
      "type": "MOBILE"
    }
  ],
  "costCenterRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "countryCode": "USA",
  "workerType": "EMPLOYEE",
  "accountingCode": "123",
  "companySpecifiedAttributes": [
    {
      "fixedColumnName": "contingentType",
      "value": "FSTV"
    }
  ],
  "designatedApproverRefs": [
    {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    }
  ],
  "authorizerEmail": "example@email.com"
}