Siga a estrutura de pergunta recomendada pelo Dev Bot antes de enviar suas dúvidas de integração.

Get group branches

GET

https://evo-integracao-api.w12app.com.br/api/v1/configuration/group-branches

🌐 API Reference/Configuration

Listar Grupos de Filiais

Descrição

Retorna a lista de grupos de filiais cadastrados no sistema, contendo a identificação do grupo, seu nome e as filiais que o compõem.

OBS. Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.

🔑 Parâmetros de Consulta (Query Params)

Parâmetro	Tipo	Obrigatoriedade	Descrição
`idBranch`	int32	Não	ID da filial utilizada para retornar apenas os grupos que a contêm.

📤 Estrutura da Resposta

Campo	Tipo	Descrição
`groupId`	int32	ID único do grupo de filiais.
`groupName`	string	Nome do grupo de filiais.
`branches`	array<object>	Lista de filiais pertencentes ao grupo. A estrutura de cada objeto está detalhada abaixo.

🧩 Estrutura do Objeto `branches`

Campo	Tipo	Descrição
`branchId`	int32	ID da filial.
`branchName`	string	Nome da filial.

Requisição

Authorization

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Parâmetros de Consulta

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://evo-integracao-api.w12app.com.br/api/v1/configuration/group-branches?idBranch=undefined' \
--header 'Authorization: Basic <encoded-value>'

Respostas

🟢200

application/json

Success

Body

Exemplo

[
    {
        "groupId": 0,
        "groupName": "string",
        "branches": [
            {
                "branchId": 0,
                "branchName": "string"
            }
        ]
    }
]