Skip to main content
GET
https://service.thatsme.com.br
/
api
/
v1.0
/
recipients
Buscar Destinatário
curl --request GET \
  --url https://service.thatsme.com.br/api/v1.0/recipients \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "invitation_id": "invite_123",
      "status": "PENDING",
      "created_at": "2024-02-01T10:30:00Z",
      "recipient": {
        "name": "João Silva",
        "email": "joao@exemplo.com",
      },
      "event_id": "event_456",
      "badge_id": "badge_789",
      "reason": "Curso de Python para Data Science com duração de 40 horas no nível Intermediário"
    }
  ],
  "count": 1
}
Endpoint de suporte operacional para localizar dados sensíveis informados no momento da emissão de certificados. Este endpoint não realiza listagem geral de destinatários e deve ser utilizado exclusivamente para conferência de informações quando um destinatário entra em contato com o emissor.
Este endpoint retorna dados sensíveis e possui regras restritivas de uso.
Não utilize para exploração, listagens amplas ou automações em massa.

​
Regras de uso

Para realizar uma busca válida, é obrigatório informar:
  • um contexto de emissão
    • event_id ou
    • badge_id
e
  • ao menos um identificador do destinatário
    • invitation_id
    • recipient_email
    • recipient_name
Campos como recipient_name e reason são auxiliares e não garantem unicidade.

​
Parâmetros de consulta

​
Contexto (obrigatório)

​
event_id
string
ID do evento associado à emissão.
​
badge_id
string
ID do badge utilizado na emissão.

​
Identificadores do destinatário (ao menos um obrigatório)

​
invitation_id
string
ID do certificado emitido.
​
recipient_email
string
E-mail informado no momento da emissão.

​
Campos auxiliares (opcionais)

​
recipient_name
string
Nome informado no momento da emissão.
​
reason
string
Motivo da emissão do certificado.

​
Resposta

​
data
array
Lista restrita de destinatários encontrados com base nos filtros informados.
​
count
number
Quantidade de registros retornados
O número de resultados é intencionalmente limitado para evitar exposição indevida de dados.

​
Exemplo de resposta

{
  "data": [
    {
      "invitation_id": "invite_123",
      "status": "PENDING",
      "created_at": "2024-02-01T10:30:00Z",
      "recipient": {
        "name": "João Silva",
        "email": "joao@exemplo.com",
      },
      "event_id": "event_456",
      "badge_id": "badge_789",
      "reason": "Curso de Python para Data Science com duração de 40 horas no nível Intermediário"
    }
  ],
  "count": 1
}

​
Exemplos de erro

​
Filtros insuficientes (faltou contexto e/ou identificador)

{
  "error": "INVALID_SEARCH",
  "message": "Informe event_id ou badge_id e pelo menos um dos seguintes: recipient_email, invitation_id."
}

​
Nenhum resultado encontrado

{
  "error": "NOT_FOUND",
  "message": "Nenhum destinatário encontrado para os filtros informados."
}

​
Rate limit (proteção contra uso indevido)

{
  "error": "RATE_LIMITED",
  "message": "Muitas requisições. Aguarde alguns instantes e tente novamente."
}

​
Acesso não autorizado

{
  "error": "UNAUTHORIZED",
  "message": "Token inválido ou ausente."
}