# Empresa empresa ## GET /empresa > Obter Listagem de Empresas ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Empresa","description":"empresa"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaEmpresas":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Empresa"}}}},"Empresa":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa (1/2)"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Empresa"},"nome":{"type":"string","description":"Nome da Empresa"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual"},"situacao":{"type":"integer","description":"Situação da Empresa (0-Inativo, 1-Ativo)","enum":[0,1]},"nomeFantasia":{"type":"string","description":"Descrição do Nome Fantasia da Empresa"},"ramoAtividade":{"type":"integer","description":"Código do Ramo de Atividade da Empresa (1-Indústria, 2-Comércio, 3-Prestação de Serviços, 4-Indústria/Comércio, 5-Indústria/Serviço, 6-Indústria/Comércio/Serviço, 7-Comércio/Serviços, 9-Outros)","enum":[1,2,3,4,5,6,7,9]},"endereco":{"type":"string","description":"Endereço da Empresa"},"numero":{"type":"string","description":"Número do Endereço da Empresa"},"complemento":{"type":"string","description":"Complemento do Endereço da Empresa"},"bairro":{"type":"string","description":"Bairro da Empresa"},"cep":{"type":"string","description":"Código do CEP da Empresa (99999-999)"},"cidade":{"type":"string","description":"Nome da Cidade da Empresa"},"estado":{"type":"string","description":"Estado da Empresa"},"codIbge":{"type":"string","description":"Código do IBGE da Empresa"},"telefoneDDD":{"type":"string","description":"DDD do Telefone da Empresa (047/041)"},"telefonePrefixo":{"type":"string","description":"Prefixo do Telefone da Empresa"},"telefone":{"type":"string","description":"Telefone da Empresa"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/empresa":{"get":{"tags":["Empresa"],"summary":"Obter Listagem de Empresas","operationId":"ObterEmpresas","parameters":[{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}},{"name":"situacao","in":"query","description":"Situação da Empresa (0 - Inativo, 1 - Ativo)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaEmpresas"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /empresa/{id} > Obter uma Empresa ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Empresa","description":"empresa"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Empresa":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa (1/2)"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ da Empresa"},"nome":{"type":"string","description":"Nome da Empresa"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual"},"situacao":{"type":"integer","description":"Situação da Empresa (0-Inativo, 1-Ativo)","enum":[0,1]},"nomeFantasia":{"type":"string","description":"Descrição do Nome Fantasia da Empresa"},"ramoAtividade":{"type":"integer","description":"Código do Ramo de Atividade da Empresa (1-Indústria, 2-Comércio, 3-Prestação de Serviços, 4-Indústria/Comércio, 5-Indústria/Serviço, 6-Indústria/Comércio/Serviço, 7-Comércio/Serviços, 9-Outros)","enum":[1,2,3,4,5,6,7,9]},"endereco":{"type":"string","description":"Endereço da Empresa"},"numero":{"type":"string","description":"Número do Endereço da Empresa"},"complemento":{"type":"string","description":"Complemento do Endereço da Empresa"},"bairro":{"type":"string","description":"Bairro da Empresa"},"cep":{"type":"string","description":"Código do CEP da Empresa (99999-999)"},"cidade":{"type":"string","description":"Nome da Cidade da Empresa"},"estado":{"type":"string","description":"Estado da Empresa"},"codIbge":{"type":"string","description":"Código do IBGE da Empresa"},"telefoneDDD":{"type":"string","description":"DDD do Telefone da Empresa (047/041)"},"telefonePrefixo":{"type":"string","description":"Prefixo do Telefone da Empresa"},"telefone":{"type":"string","description":"Telefone da Empresa"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/empresa/{id}":{"get":{"tags":["Empresa"],"summary":"Obter uma Empresa","operationId":"ObterEmpresa","parameters":[{"name":"id","in":"path","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empresa"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://ajuda.consistem.com.br/consistem-api/consistem-erp-api/comercial/cadastros-gerais-v1.0/empresa.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.