Referência

Configurações de colaborador

Conjuntos de configurações aplicáveis a colaboradores.

URL Base

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

Endpoints

GET/customer/v2/collaborator-settingsListar configurações de colaborador

Listar configurações de colaborador

GET/customer/v2/collaborator-settings

Retorna os pacotes de configurações ativos (perfil de batida, validações, comportamentos) que podem ser vinculados ao colaborador na criação. Configurações inativas não aparecem na listagem.

Query parameters

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).

Exemplos

Request

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

Response200

{
  "data": [
    {
      "id": 1,
      "description": "Padrão"
    },
    {
      "id": 2,
      "description": "Home office sem validação de localização"
    }
  ]
}

Respostas

200

{
  "data": [
    {
      "id": 1,
      "description": "Padrão"
    },
    {
      "id": 2,
      "description": "Home office sem validação de localização"
    }
  ]
}

Request

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

Response200

{
  "data": [
    {
      "id": 1,
      "description": "Padrão"
    },
    {
      "id": 2,
      "description": "Home office sem validação de localização"
    }
  ]
}