Referência

Unidades

Listar unidades de negócio.

URL Base

https://api.iopoint.com.br/api

Endpoints

GET/customer/v2/unit

Retorna as unidades ativas da empresa, ordenadas com a unidade padrão (`is_default = true`) no topo.

Nome	Tipo	Obrig.	Descrição
include_branches	boolean	não	Quando `1`, agrega a matriz e todas as filiais do grupo econômico na resposta. Só leitura.
company_national_registry	string	não	CNPJ (apenas dígitos) de uma empresa do grupo para restringir o escopo a ela. Use os CNPJs retornados em `GET /economic-group`. Fora do grupo acessível retorna `company_not_found` (404).

Request

curl -X GET "https://api.iopoint.com.br/api/customer/v2/unit" \
  -H "apiIopointToken: SEU_TOKEN_AQUI"

Response200

{
  "data": [
    {
      "id": 1,
      "name": "Matriz"
    },
    {
      "id": 2,
      "name": "Filial Centro"
    }
  ]
}

200

{
  "data": [
    {
      "id": 1,
      "name": "Matriz"
    },
    {
      "id": 2,
      "name": "Filial Centro"
    }
  ]
}

Request

curl -X GET "https://api.iopoint.com.br/api/customer/v2/unit" \
  -H "apiIopointToken: SEU_TOKEN_AQUI"

Response200

{
  "data": [
    {
      "id": 1,
      "name": "Matriz"
    },
    {
      "id": 2,
      "name": "Filial Centro"
    }
  ]
}