Agendamentos

Buscar agendamentos

get

Retorna uma lista de agendamentos com opção de filtrar por status (pendente, concluído, cancelado), serviço, usuário, cliente ou link específico.

Autorizações
AuthorizationstringObrigatório

Autenticação via Bearer Token. Inclua o token no header: Authorization: Bearer {seu_token}

Parâmetros de consulta
statusstring · enumOpcional

Filtrar por status do agendamento

Valores possíveis:
service_idstringOpcional
user_idstringOpcional
customer_idstringOpcional
link_idstringOpcional
Parâmetros de cabeçalho
Acceptstring · enumObrigatório

Tipo de conteúdo aceito na resposta

Default: application/jsonValores possíveis:
Respostas
get
/appointments
GET /v1/appointments HTTP/1.1
Host: api.lembretecerto.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json

{
  "status": "success",
  "results": [
    {
      "id": "1755606627127x527162131090447740",
      "status": "pending",
      "start": "2025-01-15T14:00:00-03:00",
      "end": "2025-01-15T15:00:00-03:00",
      "timezone": "America/Sao_Paulo",
      "user_id": "1751119337709x622783732475756500",
      "service_id": "1763322535709x988503476377223200",
      "customer_id": "1758944821033x844729154390188000",
      "link_id": "1765890123456x123456789012345600",
      "created_at": "2025-01-10T10:30:00-03:00",
      "modified_at": "2025-01-10T10:30:00-03:00",
      "cancel_url": "https://lembretecerto.com/v1/1755606627127x527162131090447740/cancel",
      "reschedule_url": "https://lembretecerto.com/v1/1755606627127x527162131090447740"
    },
    {
      "id": "1756789012345x678901234567890120",
      "status": "completed",
      "start": "2025-01-12T10:00:00-03:00",
      "end": "2025-01-12T11:30:00-03:00",
      "timezone": "America/Sao_Paulo",
      "user_id": "1751119337709x622783732475756500",
      "service_id": "1763322535709x988503476377223200",
      "customer_id": "1759123456789x987654321098765400",
      "link_id": "1765890123456x123456789012345600",
      "created_at": "2025-01-08T09:15:00-03:00",
      "modified_at": "2025-01-12T11:30:00-03:00",
      "cancel_url": "https://lembretecerto.com/v1/1756789012345x678901234567890120/cancel",
      "reschedule_url": "https://lembretecerto.com/v1/1756789012345x678901234567890120"
    }
  ],
  "count": "2",
  "remaining": "0",
  "cursor": 0
}

Criar agendamento

post

Cria um novo agendamento para um cliente específico. Requer data/hora de início, IDs do serviço, usuário, cliente e link. Valida disponibilidade e previne conflitos de horário.

Autorizações
AuthorizationstringObrigatório

Autenticação via Bearer Token. Inclua o token no header: Authorization: Bearer {seu_token}

Parâmetros de cabeçalho
Acceptstring · enumObrigatório

Tipo de conteúdo aceito na resposta

Default: application/jsonValores possíveis:
Content-Typestring · enumObrigatório

Tipo de conteúdo enviado no corpo da requisição

Default: application/jsonValores possíveis:
Corpo
startstring · date-timeObrigatório

Data/hora de início no formato ISO 8601

Example: 2025-01-15T14:00:00-03:00
service_idstringObrigatório

ID do serviço

Example: 1763322535709x988503476377223200
user_idstringObrigatório

ID do usuário responsável

Example: 1751119337709x622783732475756500
customer_idstringObrigatório

ID do cliente

Example: 1758944821033x844729154390188000
link_idstringObrigatório

ID do link de agendamento

Example: 1765890123456x123456789012345600
timezonestringOpcional

Fuso horário (ex: America/Sao_Paulo)

Default: America/Sao_PauloExample: America/Sao_Paulo
Respostas
400

Requisição inválida - dados ausentes, inválidos ou não encontrados

application/json
post
/appointments
POST /v1/appointments HTTP/1.1
Host: api.lembretecerto.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json
Content-Type: application/json
Content-Length: 255

{
  "start": "2025-01-15T14:00:00-03:00",
  "service_id": "1763322535709x988503476377223200",
  "user_id": "1751119337709x622783732475756500",
  "customer_id": "1758944821033x844729154390188000",
  "link_id": "1765890123456x123456789012345600",
  "timezone": "America/Sao_Paulo"
}
{
  "status": "success",
  "id": "1755606627127x527162131090447740"
}

Buscar agendamento por ID

get

Retorna os detalhes completos de um agendamento específico, incluindo informações do cliente, serviço, status, horários e URLs para cancelamento/reagendamento.

Autorizações
AuthorizationstringObrigatório

Autenticação via Bearer Token. Inclua o token no header: Authorization: Bearer {seu_token}

Parâmetros de rota
idstringObrigatório

ID único do agendamento

Parâmetros de cabeçalho
Acceptstring · enumObrigatório

Tipo de conteúdo aceito na resposta

Default: application/jsonValores possíveis:
Respostas
400

Requisição inválida - dados ausentes, inválidos ou não encontrados

application/json
get
/appointments/{id}
GET /v1/appointments/{id} HTTP/1.1
Host: api.lembretecerto.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json

{
  "id": "1755606627127x527162131090447740",
  "status": "pending",
  "start": "2025-01-15T14:00:00-03:00",
  "end": "2025-01-15T15:00:00-03:00",
  "timezone": "America/Sao_Paulo",
  "user_id": "1751119337709x622783732475756500",
  "service_id": "1763322535709x988503476377223200",
  "customer_id": "1758944821033x844729154390188000",
  "link_id": "1765890123456x123456789012345600",
  "created_at": "2025-01-10T10:30:00-03:00",
  "modified_at": "2025-01-10T10:30:00-03:00",
  "cancel_url": "https://lembretecerto.com/v1/1755606627127x527162131090447740/cancel",
  "reschedule_url": "https://lembretecerto.com/v1/1755606627127x527162131090447740"
}

Cancelar um agendamento (soft delete)

delete

Cancela o agendamento alterando seu status para 'canceled' sem remover o registro do banco de dados. O histórico do agendamento é preservado para fins de auditoria e relatórios.

Autorizações
AuthorizationstringObrigatório

Autenticação via Bearer Token. Inclua o token no header: Authorization: Bearer {seu_token}

Parâmetros de rota
idstringObrigatório

ID único do agendamento

Parâmetros de cabeçalho
Acceptstring · enumObrigatório

Tipo de conteúdo aceito na resposta

Default: application/jsonValores possíveis:
Respostas
400

Requisição inválida - dados ausentes, inválidos ou não encontrados

application/json
delete
/appointments/{id}
DELETE /v1/appointments/{id} HTTP/1.1
Host: api.lembretecerto.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json

{
  "status": "success",
  "id": "1755606627127x527162131090447740"
}

Atualizar/Reagendar um agendamento

patch

Permite alterar a data/hora, serviço ou usuário responsável de um agendamento existente. Valida a nova disponibilidade antes de confirmar a alteração.

Autorizações
AuthorizationstringObrigatório

Autenticação via Bearer Token. Inclua o token no header: Authorization: Bearer {seu_token}

Parâmetros de rota
idstringObrigatório

ID único do agendamento

Parâmetros de cabeçalho
Acceptstring · enumObrigatório

Tipo de conteúdo aceito na resposta

Default: application/jsonValores possíveis:
Content-Typestring · enumObrigatório

Tipo de conteúdo enviado no corpo da requisição

Default: application/jsonValores possíveis:
Corpo
startstring · date-timeOpcional

Nova data/hora de início no formato ISO 8601

Example: 2025-01-16T15:00:00-03:00
service_idstringOpcional

ID do serviço

Example: 1763322535709x988503476377223200
user_idstringOpcional

ID do usuário responsável

Example: 1751119337709x622783732475756500
timezonestringOpcional

Fuso horário

Example: America/Sao_Paulo
Respostas
400

Requisição inválida - dados ausentes, inválidos ou não encontrados

application/json
patch
/appointments/{id}
PATCH /v1/appointments/{id} HTTP/1.1
Host: api.lembretecerto.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json
Content-Type: application/json
Content-Length: 68

{
  "start": "2025-01-16T15:00:00-03:00",
  "timezone": "America/Sao_Paulo"
}
{
  "status": "success",
  "id": "1755606627127x527162131090447740"
}

Excluir permanentemente um agendamento

delete

Remove permanentemente o agendamento do banco de dados. Esta ação é irreversível e apaga completamente o registro, incluindo todo o histórico associado.

Autorizações
AuthorizationstringObrigatório

Autenticação via Bearer Token. Inclua o token no header: Authorization: Bearer {seu_token}

Parâmetros de rota
idstringObrigatório

ID único do agendamento

Parâmetros de consulta
deletestring · enumObrigatório

Deve ser 'true' para exclusão permanente

Valores possíveis:
Parâmetros de cabeçalho
Acceptstring · enumObrigatório

Tipo de conteúdo aceito na resposta

Default: application/jsonValores possíveis:
Respostas
400

Requisição inválida - dados ausentes, inválidos ou não encontrados

application/json
delete
/appointments/{id}?delete=true
DELETE /v1/appointments/{id}?delete=true?delete=true HTTP/1.1
Host: api.lembretecerto.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json

{
  "status": "success",
  "id": "1755606627127x527162131090447740"
}
AnteriorAPIPróximoDisponibilidade

Atualizado

Isto foi útil?