v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Listar Todas as Empresas (Get All Companies)

Retorna uma lista de todas as empresas cadastradas. A resposta inclui informações detalhadas como o tipo de pessoa, identificador, nome corporativo, nome de exibição e informações do usuário responsável pela empresa.

get/api/companies

Response

200

activeboolean

corporateNamestring

displayNamestring

emailstring

idinteger

identifierstring

parentCompanystring

personTypestring

phonestring

sendTypeEmailstring

Example response

[
  {
    "active": true,
    "address": {
      "additionalAddress": "string",
      "address": "string",
      "addressNumber": "string",
      "city": "string",
      "company": "string",
      "district": "string",
      "state": "st",
      "valid": true,
      "zipCode": "string"
    },
    "companyExtras": [
      {
        "attributeName": "string",
        "attributeValue": "string",
        "company": "string"
      }
    ],
    "companyQualifier": {
      "active": true,
      "billed": true,
      "key": "string",
      "name": "string"
    },
    "corporateName": "string",
    "displayName": "string",
    "email": "string",
    "identifier": "string",
    "parentCompany": "string",
    "personType": "FISICA",
    "phone": "string",
    "sendTypeEmail": "SEND_BY_DOCUMENT",
    "user": {
      "email": "string",
      "fieldSearchUser": "string",
      "firstName": "string",
      "langKey": "string",
      "lastName": "string",
      "login": "string",
      "proccessCreator": true
    },
    "users": [
      {
        "email": "string",
        "fieldSearchUser": "string",
        "firstName": "string",
        "langKey": "string",
        "lastName": "string",
        "login": "string",
        "proccessCreator": true
      }
    ],
    "usersManagers": [
      {
        "email": "string",
        "fieldSearchUser": "string",
        "firstName": "string",
        "langKey": "string",
        "lastName": "string",
        "login": "string",
        "proccessCreator": true
      }
    ],
    "webhookSettings": {
      "active": true,
      "company": "string",
      "documentApproved": true,
      "documentCanceled": true,
      "documentConcluded": true,
      "documentExpired": true,
      "documentRefused": true,
      "documentSigned": true,
      "headerName": "string",
      "headerValue": "string",
      "url": "string",
      "valid": true
    }
  }
]