Skip to main content
GET
/
api
/
v1
/
public
/
quests
/
{estabelecimento_ref}
/
active
Pesquisa Pública Ativa
curl --request GET \
  --url https://api.example.com/api/v1/public/quests/{estabelecimento_ref}/active
{
  "quest_id": "c5be8dd5-aee4-4e36-a79b-fb5e9d8f8f22",
  "empresa_id": "6f76f489-280a-4411-a3fc-cf7fc9f7ed36",
  "survey_type": "standard_csat_nps",
  "estabelecimento_slug": "minha-loja",
  "estabelecimento_nome": "Minha Loja",
  "name": "Pesquisa de satisfação",
  "description": "Queremos ouvir você",
  "research": {
    "fields": [
      {
        "id": "nota_atendimento",
        "type": "rating",
        "label": "Como foi seu atendimento?",
        "required": true
      }
    ]
  },
  "valid_until": null,
  "cta_google_configured": true,
  "profile_picture": "https://cdn.indiqai.com/empresas/logo-minha-loja.png",
  "primary_color": "#6D28D9"
}

​
Pesquisa Pública Ativa

Retorna a pesquisa pública ativa por estabelecimento, usando slug público ou ID da empresa.

​
Autenticação

Não requer token. Endpoint público para consumo via link/QR Code.

​
Identificador do estabelecimento

  • estabelecimento_ref pode ser o id_name (slug público) da empresa.
  • Também pode ser o id (UUID) da empresa.

​
Request

curl -X GET "https://api.indiqai.com/api/v1/public/quests/minha-loja/active"

​
Response

{
  "quest_id": "c5be8dd5-aee4-4e36-a79b-fb5e9d8f8f22",
  "empresa_id": "6f76f489-280a-4411-a3fc-cf7fc9f7ed36",
  "survey_type": "standard_csat_nps",
  "estabelecimento_slug": "minha-loja",
  "estabelecimento_nome": "Minha Loja",
  "name": "Pesquisa de satisfação",
  "description": "Queremos ouvir você",
  "research": {
    "fields": [
      {
        "id": "nota_atendimento",
        "type": "rating",
        "label": "Como foi seu atendimento?",
        "required": true
      }
    ]
  },
  "valid_until": null,
  "cta_google_configured": true,
  "profile_picture": "https://cdn.indiqai.com/empresas/logo-minha-loja.png",
  "primary_color": "#6D28D9"
}

​
Notas

  • O backend garante que toda empresa tenha uma pesquisa padrão CSAT/NPS (survey_type = standard_csat_nps) criada automaticamente quando necessário.
  • survey_type pode ser standard_csat_nps ou custom e deve ser usado pelo frontend para renderizar a experiência correta.

​
Erros

404 Not Found
{
  "detail": "Estabelecimento não encontrado"
}
404 Not Found
{
  "detail": "Não há pesquisa pública ativa para este estabelecimento"
}
429 Too Many Requests
{
  "detail": {
    "error": "RATE_LIMIT_EXCEEDED"
  }
}