Clientes

Buscar clientes

get

Retorna uma lista de clientes cadastrados no sistema, com opção de filtrar por nome, email, telefone ou data de criação.

Autorizações
AuthorizationstringObrigatório

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

Parâmetros de consulta
namestringOpcional

Filtrar por nome do cliente

Example: {"value":"João"}
emailstring · emailOpcional

Filtrar por email do cliente

Example: {"value":"[email protected]"}
phonestringOpcional

Filtrar por telefone do cliente

Example: {"value":"+5511987654321"}
created_atstring · date-timeOpcional

Filtrar por data de criação (formato ISO 8601)

Example: {"value":"2025-01-10T10:30:00-03:00"}
Parâmetros de cabeçalho
Acceptstring · enumObrigatório

Tipo de conteúdo aceito na resposta

Default: application/jsonValores possíveis:
Respostas
200

Operação executada com sucesso

application/json
Respostaone of
ou
get
/customers
GET /v1/customers 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 ou atualizar cliente

post

Cria um novo cliente. Se já existir um cliente com o mesmo telefone ou email, atualiza os dados do cliente existente (upsert).

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
namestringObrigatório

Nome completo do cliente (será dividido em first_name e last_name)

Example: João Silva
phonestringOpcional

Telefone com DDI internacional (ex: +5511987654321) ou local (será formatado automaticamente)

Example: +5511987654321
emailstring · emailOpcional

Endereço de email válido

Example: [email protected]
timezonestringOpcional

Fuso horário do cliente

Default: America/Sao_PauloExample: America/Sao_Paulo
country_codestringOpcional

Código do país (BR, US, ES, etc.) para formatação automática do telefone

Example: BR
Respostas
200

Operação executada com sucesso

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

{
  "name": "João Silva",
  "phone": "+5511987654321",
  "email": "[email protected]",
  "timezone": "America/Sao_Paulo",
  "country_code": "BR"
}
{
  "id": "1758944821033x844729154390188000",
  "full_name": "João Silva",
  "first_name": "João",
  "last_name": "Silva",
  "phone": "+5511987654321",
  "email": "[email protected]",
  "timezone": "America/Sao_Paulo",
  "created_at": "2025-01-10T10:30:00-03:00",
  "modified_at": "2025-01-15T14:20:00-03:00"
}

Buscar cliente por ID

get

Retorna os detalhes completos de um cliente específico, incluindo nome, contatos, fuso horário e histórico de cadastro.

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 cliente

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

Tipo de conteúdo aceito na resposta

Default: application/jsonValores possíveis:
Respostas
200

Operação executada com sucesso

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

{
  "id": "1758944821033x844729154390188000",
  "full_name": "João Silva",
  "first_name": "João",
  "last_name": "Silva",
  "phone": "+5511987654321",
  "email": "[email protected]",
  "timezone": "America/Sao_Paulo",
  "created_at": "2025-01-10T10:30:00-03:00",
  "modified_at": "2025-01-10T10:30:00-03:00"
}

Excluir cliente

delete

Remove permanentemente um cliente do sistema. Esta operação não pode ser desfeita e exclui todos os dados associados ao cliente.

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 cliente

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

Tipo de conteúdo aceito na resposta

Default: application/jsonValores possíveis:
Respostas
delete
/customers/{id}
DELETE /v1/customers/{id} HTTP/1.1
Host: api.lembretecerto.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json

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

Atualizar cliente

patch

Atualiza parcialmente as informações de um cliente existente. Apenas os campos enviados serão modificados, mantendo os demais dados inalterados.

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 cliente

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
namestringOpcional

Nome completo do cliente

Example: João Pedro Silva
phonestringOpcional

Telefone com DDI internacional ou local

Example: +5511999887766
emailstring · emailOpcional

Endereço de email

Example: [email protected]
timezonestringOpcional

Fuso horário do cliente

Example: America/Sao_Paulo
country_codestringOpcional

Código do país para formatação do telefone

Example: BR
Respostas
200

Operação executada com sucesso

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

{
  "name": "João Pedro Silva",
  "phone": "+5511999887766",
  "email": "[email protected]"
}
{
  "status": "success",
  "message": "Customer has been successfully updated."
}
AnteriorDisponibilidadePróximoModels

Atualizado

Isto foi útil?