> ## Documentation Index
> Fetch the complete documentation index at: https://docs.machine.global/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter empresas

> Retorna todas as empresas conveniadas à central, podendo também retornar os dados de uma empresa específica, ou a do usuário, caso seja um usuário da empresa. O campo "dados_extras" somente é retornado quando a autenticação é de central. Caso uma quebra de linha esteja presente, será indicada com os caracteres "\r\n". Para ter acesso à essa endpoint o usuário autenticado deve ter a permissão “API - Empresa”.



## OpenAPI

````yaml pages/v1/openapi-entregas.json GET /empresa
openapi: 3.1.0
info:
  title: API de Integração
  description: API de Integração v1
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api-vendas.taximachine.com.br/api/integracao
  - url: https://api.taximachine.com.br/api/integracao
security:
  - basicAuth: []
    ApiKeyAuth: []
paths:
  /empresa:
    get:
      summary: Obter empresas da central
      description: >-
        Retorna todas as empresas conveniadas à central, podendo também retornar
        os dados de uma empresa específica, ou a do usuário, caso seja um
        usuário da empresa. O campo "dados_extras" somente é retornado quando a
        autenticação é de central. Caso uma quebra de linha esteja presente,
        será indicada com os caracteres "\r\n". Para ter acesso à essa endpoint
        o usuário autenticado deve ter a permissão “API - Empresa”.
      parameters:
        - name: empresa_id
          in: query
          description: >-
            Caso não seja especificado, retorna todas as empresas pertencentes à
            central. Se for usuário de empresa, o endpoint irá retornar apenas
            os dados da empresa do usuário e este parâmetro é ignorado.
          schema:
            type: integer
        - name: limite
          in: query
          description: Default 20, Max 100
          schema:
            type: integer
            default: 20
            maximum: 100
        - name: pagina
          in: query
          description: Default 1
          schema:
            type: integer
            default: 1
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              example:
                success: true
                response:
                  - id: '420'
                    nome: Gaudium
                    numero_contrato: '123'
                    endereco: Rua da Assembleia
                    complemento: '10'
                    bairro: Centro
                    cidade: Rio de Janeiro
                    uf: RJ
                    cep: 20011-001
                    lat: '-22.905164000'
                    lng: '-43.176447800'
                    telefone: '21999999999'
                    telefone_internacional: '5521999999999'
                    status_empresa: A
                    data_hora_cadastro: '2023-01-01 10:00:00'
                    dados_extras: "Informação 1\r\nInformação 2"
                    tipo_documento: CNPJ
                    documento: 12.345.678/0001-90
                    tipos_pagamento:
                      - D
                      - B
                      - C
                    categorias:
                      - id: '1'
                        nome: Comum
                  - id: '474'
                    nome: Gutmann Inc
                    numero_contrato: '456'
                    endereco: Avenida Brasil
                    complemento: null
                    bairro: Bonsucesso
                    cidade: Rio de Janeiro
                    uf: RJ
                    cep: 21040-000
                    lat: '-22.876543000'
                    lng: '-43.234567000'
                    telefone: '21888888888'
                    telefone_internacional: '5521888888888'
                    status_empresa: S
                    data_hora_cadastro: '2023-02-01 11:00:00'
                    dados_extras: "Outros dados\r\nMais dados"
                    tipo_documento: CPF
                    documento: 123.456.789-00
                    tipos_pagamento:
                      - D
                    categorias:
                      - id: '2'
                        nome: Executivo
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api-key
      description: Obrigatório. Sua chave API.

````