Get All Companies

Retrieves a list of all companies filtered by the specified parameters.

Authentication

This endpoint requires authentication. See Authentication for details.

Filters

Property	Type	Required	Description
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 /companies

Example Request

{
  "request": "companies",
  "vendor": "tecspal",
  "verb": "GET",
  "filters": {
    "countryCode": "UY"
  }
}

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 companies

Company Properties

Property	Type	Description
id	string	Unique identifier of the company
createdAt	string	Creation timestamp in ISO 8601 format
name	string	Official name of the company
legalNumber	string	Official registration number of the company
countryCode	string	ISO 3166-1 alpha-2 country code (e.g., "UY")
companyCode	string	Unique short code identifying the company
contactEmail	string	Contact email address of the company
phone	string	Contact phone number of the company
webhookUrl	string	URL for receiving webhooks (if applicable)
abmCode	string	ABM code if assigned (nullable)

Example Response

{
  "statusCode": 200,
  "message": "Request successful",
  "envelop": [
    {
      "id": "9dd6875c-9a60-4377-8034-f2e243e3fefb",
      "createdAt": "2025-04-09T14:35:57.199Z",
      "name": "Larian Studios",
      "legalNumber": "12464105",
      "countryCode": "UY",
      "companyCode": "DM1",
      "contactEmail": "larian@tecspal.com",
      "phone": "+598 901232",
      "webhookUrl": null,
      "abmCode": null
    },
    {
      "id": "44e3815d-1e48-4ad0-9c5e-974db0cd4ec2",
      "createdAt": "2025-04-11T21:01:13.470Z",
      "name": "Warhorse Studios",
      "legalNumber": "123456",
      "countryCode": "UY",
      "companyCode": "WWS",
      "contactEmail": "warhorse@tecspal.com",
      "phone": "+598 8888888",
      "webhookUrl": null,
      "abmCode": null
    }
  ]
}

Error Responses

Unauthorized (401)

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

Notes

• the response includes only companies related to the user.
• Country code filter must be in ISO 3166-1 alpha-2 format (e.g., "UY", "US")