Skip to main content
GET
/
companies
List all companies for the current tenant
curl --request GET \
  --url https://api.example.com/companies
[
  {
    "id": "e4b6d4e8-8e6d-41da-abdb-8fc358a9e7f1",
    "tenantId": "e305e9a4-585e-49b8-bc88-9fba992c6326",
    "name": "Acme Corp",
    "document": "12345678000199",
    "status": "ACTIVE",
    "email": "contact@acme.com",
    "address": {
      "street": "Av Paulista",
      "number": "1000",
      "city": "São Paulo",
      "state": "SP",
      "zipCode": "01310-100"
    },
    "settings": {},
    "taxRegime": "SIMPLES_NACIONAL",
    "costMethod": "WEIGHTED_AVERAGE",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-01T12:00:00.000Z"
  }
]

​
Response

[
  {
    "id": "e4b6d4e8-8e6d-41da-abdb-8fc358a9e7f1",
    "tenantId": "e305e9a4-585e-49b8-bc88-9fba992c6326",
    "name": "Acme Corp",
    "document": "12345678000199",
    "status": "ACTIVE",
    "email": "contact@acme.com",
    "address": {
      "street": "Av Paulista",
      "number": "1000",
      "city": "São Paulo",
      "state": "SP",
      "zipCode": "01310-100"
    },
    "settings": {},
    "taxRegime": "SIMPLES_NACIONAL",
    "costMethod": "WEIGHTED_AVERAGE",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-01T12:00:00.000Z"
  }
]

Response

200 - application/json

Return all companies.

​
name
string
required

Company Name

Example:

"Acme Corp"

​
document
string
required

CNPJ or CPF

Example:

"12345678000199"

​
status
enum<string>
required

Company Status

Available options:
ACTIVE,
DISABLED,
BLOCKED,
SUSPENDED
Example:

"ACTIVE"

​
settings
object
required

Configuration Settings

Example:
{}
​
taxRegime
enum<string>
required

Tax Regime

Available options:
SIMPLES_NACIONAL,
LUCRO_PRESUMIDO,
LUCRO_REAL
Example:

"SIMPLES_NACIONAL"

​
costMethod
enum<string>
required

Cost Method

Available options:
REPLACEMENT,
WEIGHTED_AVERAGE
Example:

"WEIGHTED_AVERAGE"

​
email
string

Contact Email

Example:

"contact@acme.com"

​
address
object

Address Object