Obtenha configurações da conta

Retorna configurações e metadados da conta autenticada: usuários, origens de leads, tipos de tarefas, fases processuais, tipos de processos e dados financeiros.

Este endpoint fornece os IDs de referência necessários para criar/atualizar registros em outros endpoints.

Campos retornados:

users - Usuários do escritório (use id em: Customers, Lawsuits, Tasks, Transactions)
origins - Origens de leads (use id como customers_origins_id em: Customers)
tasks - Tipos de tarefas disponíveis (use id como tasks_id em: Tasks/Posts)
stages - Fases processuais (use id como stages_id em: Lawsuits)
type_lawsuits - Tipos de processos por área do direito (use id como type_lawsuits_id em: Lawsuits)
financial - Dados financeiros:
- banks - Contas bancárias (use id como debit_account em: Transactions)
- categories - Categorias financeiras com tipo CRÉDITO/DÉBITO (use id como categories_id em: Transactions)
- cost_centers - Centros de custo (use id como cost_centers_id em: Transactions)
- departments - Departamentos (use id como sectors_id em: Transactions)

Recomendação: Execute este endpoint ao inicializar sua integração e armazene os IDs em cache para uso nas operações subsequentes.

⚠️ Os IDs retornados são específicos da sua conta.

Authorization

BearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://app.advbox.com.br/api/v1/settings"

{
  "users": [
    {
      "id": 12345,
      "name": "João Silva",
      "email": "joao.silva@example.com",
      "cellphone": "(11) 99999-9999"
    },
    {
      "id": 12346,
      "name": "Maria Santos",
      "email": "maria.santos@example.com",
      "cellphone": "(11) 98888-8888"
    }
  ],
  "origins": [
    {
      "id": 100,
      "origin": "INDICAÇÃO"
    },
    {
      "id": 101,
      "origin": "FACEBOOK"
    },
    {
      "id": 102,
      "origin": "GOOGLE"
    },
    {
      "id": 103,
      "origin": "SITE DO ESCRITÓRIO"
    }
  ],
  "tasks": [
    {
      "id": 500,
      "task": "1º CONTATO COM O LEAD",
      "reward": 10
    },
    {
      "id": 501,
      "task": "ACOMPANHAR CITAÇÃO",
      "reward": 20
    },
    {
      "id": 502,
      "task": "PROTOCOLAR PETIÇÃO",
      "reward": 30
    }
  ],
  "stages": [
    {
      "id": 200,
      "stage": "PRIMEIRO CONTATO",
      "step": "MARKETING"
    },
    {
      "id": 201,
      "stage": "ANÁLISE DO CASO",
      "step": "NEGOCIAÇÃO"
    },
    {
      "id": 202,
      "stage": "EM ANDAMENTO",
      "step": "JUDICIAL"
    }
  ],
  "type_lawsuits": [
    {
      "id": 300,
      "type": "AÇÃO TRABALHISTA",
      "group": "TRABALHISTA"
    },
    {
      "id": 301,
      "type": "AÇÃO DE COBRANÇA",
      "group": "CÍVEL"
    },
    {
      "id": 302,
      "type": "DIVÓRCIO",
      "group": "FAMÍLIA"
    }
  ],
  "financial": {
    "banks": [
      {
        "id": 1001,
        "name": "CONTA PRINCIPAL",
        "institution": "Banco Exemplo S.A."
      },
      {
        "id": 1002,
        "name": "INVESTIMENTOS",
        "institution": null
      },
      {
        "id": 1003,
        "name": "DINHEIRO",
        "institution": null
      }
    ],
    "categories": [
      {
        "id": 100,
        "category": "HONORÁRIOS",
        "type": "CRÉDITO"
      },
      {
        "id": 101,
        "category": "CUSTAS PROCESSUAIS",
        "type": "CRÉDITO"
      },
      {
        "id": 200,
        "category": "ÁGUA",
        "type": "DÉBITO"
      },
      {
        "id": 201,
        "category": "ALUGUEL",
        "type": "DÉBITO"
      },
      {
        "id": 202,
        "category": "ENERGIA ELÉTRICA",
        "type": "DÉBITO"
      }
    ],
    "cost_centers": [
      {
        "id": 500,
        "cost_center": "GERAL"
      },
      {
        "id": 501,
        "cost_center": "ADMINISTRATIVO"
      }
    ],
    "departments": []
  }
}

{
  "error": "Unauthenticated."
}

Obtenha configurações da conta

Campos retornados:

Authorization

Response Body

200application/json

401application/json

`application/json`

`application/json`