Skip to main content

Get Employee By Id

Retrieves detailed information about a specific employee using their unique identifier.

Authentication

This endpoint requires authentication. See Authentication for details.

Parameters

PropertyTypeRequiredDescription
employeeIdstringYesThe id of the employee

Filters

PropertyTypeRequiredDescription
companyCodestringYesCompany code for one of your managed companies

Request

Production URL: https://orchestrator.tecspal.com/
Sandbox URL: https://tecspal-orchestrator.sandbox.lexartlabs.uy/
Endpoint: GET /employees/{employeeId}

Example Request

{
"filters": {
"companyCode": "DM1"
},
"request": "employees/acf8c4ee-f403-4f20-8503-7be0dbdd8592",
"vendor": "tecspal",
"verb": "GET"
}

Response Schema

PropertyTypeDescription
statusCodenumberHTTP status code of the response
messagestringDescription of the response status
enveloparrayArray containing the employee data

Employee Properties

PropertyTypeDescription
idstringUnique identifier of the employee
createdAtstringDate and time when the employee was created (ISO 8601)
updatedAtstringDate and time when the employee was last updated (ISO 8601)
firstNamestringFirst name of the employee
lastNamestringLast name of the employee
emailstringEmail address of the employee
statusstringCurrent status of the employee (e.g., "ACTIVE", "INACTIVE")
phonestringPhone number including country code
governmentDNIstringGovernment-issued identification number
cpfstring | nullBrazilian identification number
addressstringPrimary address of the employee
addressExtraInfostring | nullAdditional address information
postCodestringPostal or ZIP code
countryCodestringISO 3166-1 alpha-2 country code (e.g., "UY")
companyNamestringName of the company the employee belongs to
hardwaresarrayList of hardware items assigned to the employee

hardwares Properties

PropertyTypeDescription
idstringUnique identifier of the hardware item
descriptionstring | nullDescription of the hardware (nullable)
brandstringBrand or manufacturer of the hardware
serialNumberstringSerial number of the hardware
namestringName of the hardware item
imagestringURL to an image of the hardware
ramstringRAM specification (if applicable)
diskSpacestringDisk size specification (if applicable)
displaySizestringDisplay size specification (if applicable)
processorstringProcessor specification (if applicable)
movementRequestsarrayList of movement request objects related to hardware

movementRequests Properties

PropertyTypeDescription
idstringUnique identifier of the request
statusstringStatus of the movement request

Example Response

{
"envelop": [
{
"id": "04fb50a9-60fb-414a-ab2b-fa3f8ea8689e",
"createdAt": "2025-04-09T14:35:57.249Z",
"updatedAt": "2025-04-09T14:35:57.249Z",
"firstName": "Juan",
"lastName": "Iruleguy",
"email": "jiruleguy@tecspal.com",
"status": "ACTIVE",
"phone": "+5982432342",
"governmentDNI": "123456",
"cpf": null,
"address": "Pedro Domingo Murillo 6566, Montevideo, Departamento de Montevideo",
"addressExtraInfo": null,
"postCode": "11500",
"countryCode": "UY",
"companyName": "Larian Studios",
"hardwares": [
{
"id": "a656198b-7a7f-4158-ae6e-9c67596e95a8",
"description": "Good shape",
"serialNumber": "1523",
"name": "MOUSE",
"image": "https://a-us.storyblok.com/f/1001855/194x310/58f252e365/generic-mouse.png",
"movementRequests": [
{
"id": "06003363-044e-4eb8-8c7f-b414df9453bf",
"status": "PROCESSING"
}
]
},
{
"id": "86890299-6aa2-457f-8918-a27a6d017559",
"description": "",
"serialNumber": "123456",
"name": "MacBook Pro",
"ram": "16GB",
"diskSpace": "512GB",
"displaySize": "16 inch",
"processor": "M1 Pro",
"image": "https://a-us.storyblok.com/f/1001855/789x500/82ee51ba4d/macbook-pro-16.png",
"movementRequests": []
},
{
"id": "1bf3bf55-d3d5-49cc-b413-68969d4558f2",
"description": "",
"serialNumber": "123",
"name": "HEADPHONES",
"image": "https://a-us.storyblok.com/f/1001855/800x800/eacb7e6f4f/headphones.png",
"movementRequests": []
},
{
"id": "ada1900e-dcc0-48e1-a4f1-8352a084f276",
"description": "",
"serialNumber": "456",
"name": "MOUSE",
"image": "https://a-us.storyblok.com/f/1001855/194x310/58f252e365/generic-mouse.png",
"movementRequests": []
},
{
"id": "c6cd9d36-5a89-4dd3-8d97-1e1e528ab60e",
"description": "",
"serialNumber": "789",
"name": "KEYBOARD",
"image": "https://a-us.storyblok.com/f/1001855/560x252/b4203f1c61/generic-keyboard.png",
"movementRequests": []
}
]
}
],
"message": "Request successful",
"statusCode": 200
}

Error Responses

Employee Not Found (404)

{
"error": "Not Found",
"message": "Employee not found",
"statusCode": 404
}

Unauthorized (401)

{
"error": "Unauthorized",
"message": "Unauthorized access",
"statusCode": 401
}

Bad Request (400)

{
"error": "Bad Request",
"message": "Invalid employee ID format",
"statusCode": 400
}

Notes

  • The lat and lng fields provide geolocation coordinates for the employee's address
  • The hardwares array contains all hardware items that have been assigned to the employee
  • When cpf is null, it means the employee doesn't have a Brazilian tax ID
  • The companyId field can be used to verify the employee belongs to the expected company