Pular para o conteúdo
Tarefas

Listar tarefas

v1.0.0
GEThttps://api.staging.growthaisystem.com/api/v1/tasks
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposcontacts.read

Filtros (todos opcionais, combináveis): assigneeUserId; contactId e opportunityId (as tarefas de um contato ou de um negócio); internal=true (só as tarefas internas, sem contato nem negócio) ou internal=false (só as com vínculo); status = open (pendentes), done (concluídas) ou overdue (pendentes com prazo vencido); dueAfter/dueBefore (ISO-8601, > e <) recortam pelo prazo. open=true continua valendo como antes. Paginação por cursor keyset, limit até 500.

Parâmetros de consulta

Vão na querystring, depois do ?.

  • assigneeUserIdstringopcional
  • openstringopcional
    • um de"true""false"
  • contactIdstringopcional
  • opportunityIdstringopcional
  • internalstringopcional
    • um de"true""false"
  • statusstringopcional
    • um de"open""done""overdue"
  • dueAfterstringopcional
  • dueBeforestringopcional
  • cursorstringopcional
  • limitintegeropcional
    • padrão 50
    • faixa 1–500

Respostas

6 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Página de tarefas do workspace, da mais recente para a mais antiga; nextCursor traz o cursor da página seguinte e vem null na última.

  • Cada item — V1Task

    • idstring
    • contactIdstring | null
    • opportunityIdstring | null
    • titlestring
    • bodystring | null
    • dueAtstring | null
    • completedAtstring | null
    • assigneeUserIdstring | null
    • createdAtstring
  • nextCursorstring | null

    Cursor opaco da PRÓXIMA página — passe em ?cursor=. null = acabou a lista.