Get user business info

Request

This endpoint gets user business info by user ID.

Security

Bearer

Path

userIdstring, (uuid)required

Identifier for user.

Example:4974a66b-7493-4f41-908c-58ba81093947

Query

includeInactiveboolean

Include inactive users.

Default:false

Example:includeInactive=true

curl -i -X GET \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/business-info?includeInactive=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

departmentRefobject(Reference object containing uuid and name of the entity.)

Reference of an entity

designationstring

Example:"MANAGER"

emailstring, (email)

Example:"user@business.com"

employeeIdstring

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

Example:"101"

gradeRefobject(Reference object containing uuid and name of the entity.)

Reference of an entity

legalEntityRefobject(Reference object containing uuid and name of the entity.)required

Reference of an entity

managerRefobject(Reference object containing uuid and name of the entity.)

Reference of an entity

officeRefobject(Reference object containing uuid and name of the entity.)

Reference of an entity

organizationRefobject(Reference object containing uuid and name of the entity.)required

Reference of an entity

phoneNumbersArray of objects(PhoneNumber)

costCenterRefobject(Reference object containing uuid and name of the entity.)

Reference of an entity

countryCodestring

alpha-2 or alpha-3 ISO country code.

Example:"USA"

workerTypestring(WorkerType)

The type of worker.

Enum:"EMPLOYEE""CONTINGENT""SEASONAL""INTERN""GUEST"

Example:"EMPLOYEE"

accountingCodestring

Code used for accounting.

Example:"123"

companySpecifiedAttributesArray of objects(CompanySpecifiedAttribute)

designatedApproverRefsArray of objects(Reference object containing uuid and name of the entity.)

A list of references for designated approvers.

authorizerEmailstring

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

Example:"example@email.com"

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": [
    { … }
  ],
  "costCenterRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "countryCode": "USA",
  "workerType": "EMPLOYEE",
  "accountingCode": "123",
  "companySpecifiedAttributes": [
    { … }
  ],
  "designatedApproverRefs": [
    { … }
  ],
  "authorizerEmail": "example@email.com"
}