Skip to main content

Get All Companies

Retrieves a list of companies associated with your API client.

Authentication

This endpoint requires authentication. See Authentication for details.

Request

Production URL: https://orchestrator.tecspal.com/
Sandbox URL: https://orchestrator-dev.tecspal.com/
Endpoint: GET /companies

Example Request

{
"request": "companies",
"vendor": "tecspal",
"verb": "GET"
}

Response Schema

PropertyTypeDescription
statusCodenumberHTTP status code of the response
messagestringDescription of the response status
enveloparrayArray containing the list of companies

Company Properties

PropertyTypeDescription
idstringUnique identifier of the company
createdAtstringCreation timestamp in ISO 8601 format
namestringOfficial name of the company
companyCodestringUnique short code identifying the company
abmCodestringABM code if assigned (nullable)
webhookUrlstringURL for receiving webhooks (nullable)
companySourcestringCompany source (e.g. INTERNAL)

Example Response

{
"statusCode": 200,
"message": "Request successful",
"envelop": [
{
"id": "9dd6875c-9a60-4377-8034-f2e243e3fefb",
"createdAt": "2025-04-09T14:35:57.199Z",
"name": "Larian Studios",
"companyCode": "DM1",
"webhookUrl": null,
"abmCode": null,
"companySource": "INTERNAL"
},
{
"id": "44e3815d-1e48-4ad0-9c5e-974db0cd4ec2",
"createdAt": "2025-04-11T21:01:13.470Z",
"name": "Warhorse Studios",
"companyCode": "WWS",
"webhookUrl": null,
"abmCode": null,
"companySource": "INTERNAL"
}
]
}

Error Responses

Unauthorized (401)

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

Notes

  • The response includes only companies linked to your API client.