For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentaçãoReferência da API
DocumentaçãoReferência da API
  • Integrações privadas
        • GETListar consultas
        • GETListar preços por profissional
        • GETListar itens de consulta
        • GETListar materiais de consulta
        • POSTCriar consulta
        • PUTAtualizar consulta
        • POSTRemarcar consulta
        • POSTConfirmar presença da consulta
        • POSTCancelar confirmação de presença
        • POSTCancelar consulta
        • POSTEncerrar consulta com no-show
        • POSTFinalizar consulta
  • Entrada pública de leads
LogoLogo
Integrações privadasConsultórioConsultas

Listar consultas

||View as Markdown|
GET
/simplificav2/consulta
GET
/ords/gestao/simplificav2/consulta
$curl https://gestao.simplificagestao.com.br/ords/gestao/simplificav2/consulta \
>     -H "Authorization: Bearer <token>"
1{
2  "count": 1,
3  "hasMore": true,
4  "limit": 1,
5  "offset": 1,
6  "items": [
7    {
8      "id": 1,
9      "pessoa_id": 1,
10      "consultor_id": 1,
11      "profissional_id": 1,
12      "agendamento_id": 1,
13      "data_consulta": "string",
14      "hora_inicial": "string",
15      "hora_final": "string",
16      "status": "string",
17      "descricao": "string",
18      "dt_encerramento": "string",
19      "descricao_encerramento": "string",
20      "remarcado_pelo_cliente": "string",
21      "consultor_encerramento_id": 1,
22      "motivo_id": 1,
23      "confirma_presenca": "string",
24      "confirma_chegada": "string",
25      "encaixe": "string",
26      "dt_confirma_presenca": "string",
27      "usuario_confirma_presenca_id": 1,
28      "motivo_consulta_id": 1,
29      "em_atendimento": "string",
30      "dt_hora_inicio_atend": "string",
31      "dt_hora_fim_atend": "string",
32      "token_consulta": "string",
33      "link_confirmacao_consulta": "string",
34      "consulta_simplifica_id": 1,
35      "recorrencia_id": 1,
36      "recorrencia_ordem": 1,
37      "recorrencia_total": 1,
38      "recorrencia_frequencia": "string",
39      "ativo": "string",
40      "empresa_id": 1,
41      "criado_em": "string",
42      "criado_por": "string",
43      "alterado_em": "string",
44      "alterado_por": "string"
45    }
46  ],
47  "links": [
48    {
49      "rel": "string",
50      "href": "string"
51    }
52  ]
53}
Retorna as consultas do consultório da empresa autenticada. Uso comum: - sincronizar agenda de atendimento; - consultar status, confirmação e recorrência; - cruzar consulta com pessoa, consultor e profissional. Exemplo de uso: ```http GET {{base_url}}/simplificav2/consulta?q={"ativo":"S"} Authorization: Bearer {{bearer_token}} Accept: application/json ```
Was this page helpful?
Previous

Inativar bloqueio de agenda

Next

Listar preços por profissional

Built with

Retorna as consultas do consultório da empresa autenticada.

Uso comum:

  • sincronizar agenda de atendimento;
  • consultar status, confirmação e recorrência;
  • cruzar consulta com pessoa, consultor e profissional.

Exemplo de uso:

1GET {{base_url}}/simplificav2/consulta?q={"ativo":"S"}
2Authorization: Bearer {{bearer_token}}
3Accept: application/json

Authentication

AuthorizationBearer
Token privado usado para consultar dados da plataforma. Como usar: - obtenha o token privado da sua empresa; - envie `Authorization: Bearer SEU_TOKEN_PRIVADO`; - não use `x-api-key` neste módulo.

Query parameters

offsetintegerOptional>=0

Quantos registros pular antes de começar a resposta.

limitintegerOptional>=1
Quantidade máxima de registros por resposta. Observação: - informe `limit` explicitamente quando quiser controlar a quantidade por resposta.
qstringOptional
Filtro opcional para restringir, combinar ou ordenar os resultados. Se você não enviar `q`, o endpoint retorna a listagem padrão daquele recurso. Quando precisar filtrar, o `q` recebe um JSON no padrão FilterObject do ORDS. Regras práticas: - comece testando o endpoint sem filtro; - use os nomes de coluna publicados naquele endpoint; - use sempre o nome do campo exatamente como ele aparece no schema do endpoint; - `offset` e `limit` não entram dentro do `q`; - em clientes HTTP fora do Postman, o conteúdo normalmente precisa ser enviado URL-encoded; - no Postman, prefira informar o valor na aba `Params`. Operadores úteis: - `$or` - `$between` - `$orderby` - `$date` - `$ne`, `$lt`, `$lte`, `$gt`, `$gte` - `$instr`, `$ninstr` - `$notnull` Exemplos legíveis: - `{"id":162472}` - `{"ativo":"S"}` - `{"receita_recorrente_id":{"$notnull":null}}` - `{"status":"ABERTO","$orderby":{"data_vencimento":"ASC"}}` - `{"criado_em":{"$between":[{"$date":"2026-03-01T00:00:00Z"},{"$date":"2026-03-31T23:59:59Z"}]}}` Os mesmos exemplos prontos para URL: - `%7B%22id%22%3A162472%7D` - `%7B%22ativo%22%3A%22S%22%7D` - `%7B%22receita_recorrente_id%22%3A%7B%22%24notnull%22%3Anull%7D%7D` - `%7B%22status%22%3A%22ABERTO%22%2C%22%24orderby%22%3A%7B%22data_vencimento%22%3A%22ASC%22%7D%7D` - `%7B%22criado_em%22%3A%7B%22%24between%22%3A%5B%7B%22%24date%22%3A%222026-03-01T00%3A00%3A00Z%22%7D%2C%7B%22%24date%22%3A%222026-03-31T23%3A59%3A59Z%22%7D%5D%7D%7D`

Response

Coleção paginada de consultas.

countinteger
hasMoreboolean
limitinteger
offsetinteger
itemslist of objects
linkslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error

Token privado usado para consultar dados da plataforma.

Como usar:

  • obtenha o token privado da sua empresa;
  • envie Authorization: Bearer SEU_TOKEN_PRIVADO;
  • não use x-api-key neste módulo.

Quantidade máxima de registros por resposta.

Observação:

  • informe limit explicitamente quando quiser controlar a quantidade por resposta.

Filtro opcional para restringir, combinar ou ordenar os resultados.

Se você não enviar q, o endpoint retorna a listagem padrão daquele recurso.

Quando precisar filtrar, o q recebe um JSON no padrão FilterObject do ORDS.

Regras práticas:

  • comece testando o endpoint sem filtro;
  • use os nomes de coluna publicados naquele endpoint;
  • use sempre o nome do campo exatamente como ele aparece no schema do endpoint;
  • offset e limit não entram dentro do q;
  • em clientes HTTP fora do Postman, o conteúdo normalmente precisa ser enviado URL-encoded;
  • no Postman, prefira informar o valor na aba Params.

Operadores úteis:

  • $or
  • $between
  • $orderby
  • $date
  • $ne, $lt, $lte, $gt, $gte
  • $instr, $ninstr
  • $notnull

Exemplos legíveis:

  • {"id":162472}
  • {"ativo":"S"}
  • {"receita_recorrente_id":{"$notnull":null}}
  • {"status":"ABERTO","$orderby":{"data_vencimento":"ASC"}}
  • {"criado_em":{"$between":[{"$date":"2026-03-01T00:00:00Z"},{"$date":"2026-03-31T23:59:59Z"}]}}

Os mesmos exemplos prontos para URL:

  • %7B%22id%22%3A162472%7D
  • %7B%22ativo%22%3A%22S%22%7D
  • %7B%22receita_recorrente_id%22%3A%7B%22%24notnull%22%3Anull%7D%7D
  • %7B%22status%22%3A%22ABERTO%22%2C%22%24orderby%22%3A%7B%22data_vencimento%22%3A%22ASC%22%7D%7D
  • %7B%22criado_em%22%3A%7B%22%24between%22%3A%5B%7B%22%24date%22%3A%222026-03-01T00%3A00%3A00Z%22%7D%2C%7B%22%24date%22%3A%222026-03-31T23%3A59%3A59Z%22%7D%5D%7D%7D