Skip to content

Companies

The Companies entity represents the organizational units within the system.

Fields

FieldTypeDescription
idIntegerUnique identifier (Primary Key).
nameStringHuman-readable name of the company.
descriptionStringDetailed description of the company.
addressStringPhysical or legal address of the company.
registrationCodeStringOfficial registration code or tax ID.
createdAtDateTimeMetadata: Creation timestamp.
createdByRelationUser who created the record.
updatedAtDateTimeMetadata: Last update timestamp.
deletedAtDateTimeMetadata: Deletion timestamp (for soft delete).
removedByRelationUser who removed the record.

Get List of Companies

Fetch a list of companies with specified fields and filters.

Endpoint: POST /core/data/Companies/select

Example Request:

json
{
  "fields": {
    "id": true,
    "name": true,
    "registrationCode": true,
    "address": true
  },
  "orderBy": [
    {
      "field": "name",
      "order": "asc"
    }
  ],
  "limit": 100,
  "offset": 0
}

Get Single Company

Retrieve details for a specific company by ID.

Endpoint: POST /core/data/Companies/select

Example Request:

json
{
  "fields": {
    "id": true,
    "name": true,
    "description": true,
    "address": true,
    "registrationCode": true,
    "createdAt": true
  },
  "conditions": {
    "filters": [
      {
        "field": "id",
        "comparator": "=",
        "value": 1
      }
    ]
  },
  "limit": 1
}