Get All Employees

Retrieves a list of all employees for the specified company.

Authentication

This endpoint requires authentication. See Authentication for details.

Filters

Property	Type	Required	Description
companyCode	string	Yes	Company code for one of your managed companies
countryCode	string	No	Country code in ISO 3166-1 alpha-2 format

Request

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

Example Request

{
  "filters": {
    "companyCode": "DM1",
    "countryCode": "UY"
  },
  "request": "employees",
  "vendor": "tecspal",
  "verb": "GET"
}

Response Schema

Property	Type	Description
statusCode	number	HTTP status code of the response
message	string	Description of the response status
envelop	array	Array containing the list of employees

Employee Properties

Property	Type	Description
id	string	Unique identifier of the employee
createdAt	string	Date and time when the employee was created (ISO 8601)
updatedAt	string	Date and time when the employee was last updated (ISO 8601)
firstName	string	First name of the employee
lastName	string	Last name of the employee
email	string	Email address of the employee
status	string	Current status of the employee (e.g., `"ACTIVE"`, `"INACTIVE"`)
phone	string	Phone number of the employee
governmentDNI	string	Government-issued identification number
cpf	string \| null	Brazilian identification number
address	string	Primary address of the employee
addressExtraInfo	string \| null	Additional address information
postCode	string	Postal/ZIP code
countryCode	string	ISO 3166-1 alpha-2 country code (e.g., `"UY"`)
companyName	string	Name of the company the employee belongs to
hardwares	array	List of hardware items assigned to the employee

`hardwares` Properties

Property	Type	Description
id	string	Unique identifier of the hardware
brand	string	Brand or manufacturer of the hardware
description	string	Description of the hardware
serialNumber	string	Serial number of the hardware
name	string	Name/type of the hardware
ram	string	RAM size (if applicable, e.g., laptops)
diskSpace	string	Disk space (if applicable)
displaySize	string	Display size (if applicable)
processor	string	Processor info (if applicable)
image	string	URL to an image representing the device

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"
        },
        {
          "id": "86890299-6aa2-457f-8918-a27a6d017559",
          "description": "",
          "brand": null,
          "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"
        },
        {
          "id": "1bf3bf55-d3d5-49cc-b413-68969d4558f2",
          "description": "",
          "serialNumber": "123",
          "name": "HEADPHONES",
          "image": "https://a-us.storyblok.com/f/1001855/800x800/eacb7e6f4f/headphones.png"
        },
        {
          "id": "ada1900e-dcc0-48e1-a4f1-8352a084f276",
          "description": "",
          "serialNumber": "456",
          "name": "MOUSE",
          "image": "https://a-us.storyblok.com/f/1001855/194x310/58f252e365/generic-mouse.png"
        },
        {
          "id": "c6cd9d36-5a89-4dd3-8d97-1e1e528ab60e",
          "description": "",
          "serialNumber": "789",
          "name": "KEYBOARD",
          "image": "https://a-us.storyblok.com/f/1001855/560x252/b4203f1c61/generic-keyboard.png"
        }
      ]
    },
    {
      "id": "0a86b6c2-7373-42fa-a44a-70857cef0f90",
      "createdAt": "2025-04-10T14:58:05.119Z",
      "updatedAt": "2025-04-10T14:58:05.119Z",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john_doe@email.com",
      "status": "ACTIVE",
      "phone": "+598 99999999",
      "governmentDNI": "DNI123456",
      "cpf": null,
      "address": "Plaza Independencia 848, Montevidéu, Uruguai",
      "addressExtraInfo": "Praça Independência",
      "postCode": "11100",
      "countryCode": "UY",
      "companyName": "Larian Studios",
      "hardwares": []
    },
    "..."
  ],
  "message": "Request successful",
  "statusCode": 200
}

Error Responses

Bad Request (400)

{
  "error": "Bad Request",
  "message": "Missing required filter: companyCode",
  "statusCode": 400
}

Unauthorized (401)

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

Notes

The response includes both active and inactive employees
Country code filter must be in ISO 3166-1 alpha-2 format (e.g., "UY", "US")
The hardwares array contains hardware items that have been assigned to the employee
When cpf is null, it means the employee doesn't have a Brazilian tax ID

Authentication​

Filters​

Request​

Example Request​

Response Schema​

Employee Properties​

hardwares Properties​

Example Response​

Error Responses​

Bad Request (400)​

Unauthorized (401)​

Notes​