PicChat

Automações

Listar automações

GEThttps://api.picchat.com.br/v1/automations

Lista as automações de disparo da conta (excluídas ficam de fora), ordenadas por created_at, com contadores de envio e tempos médios de leitura e resposta. Filtra por campanha, canal, modelo, status, tipo, ativa e período de criação.

Autenticação: Bearer tokenPermissão: Automações › ver

Parâmetros de consulta (query)

  • pageintegerpadrão 1

    Página, começando em 1. Valor ausente, inválido ou menor que 1 vira 1.

  • limitintegerpadrão 20

    Itens por página. Padrão 20, máximo 100: acima disso é reduzido para 100 sem erro; valor inválido ou menor que 1 vira 20.

  • campaign_idstring (uuid)

    Só automações desta campanha.

  • channel_idstring (uuid)

    Só automações deste canal.

  • template_idstring (uuid)

    Só automações que usam este modelo.

  • statusstring

    Status.

  • typestring

    Tipo de envio.

  • activeboolean

    true = só ativas; false = só inativas. Aceita `true`/`false` (também `1`/`0`, `yes`/`no`, `sim`/`nao`); outro valor é ignorado.

  • searchstring

    Busca parcial no nome, sem diferenciar maiúsculas.

  • fromstring

    Início do período por `created_at` (inclusive), em ISO 8601 (`2026-09-01` ou `2026-09-01T03:00:00Z`). Só a data = 00:00 UTC. Valor inválido → 400.

  • tostring

    Fim do período por `created_at` (inclusive), em ISO 8601. Só a data inclui o dia inteiro (até 23:59:59.999 UTC). Valor inválido → 400.

  • orderstringpadrão "desc"

    Direção da ordenação por `created_at`. Qualquer outro valor usa o padrão.

Respostas

200OK

  • itemsarray<Automation>obrigatório

    Registros da página.

  • items[].idstring (uuid)obrigatório

    ID da automação.

  • items[].namestring | nullobrigatório

    Nome.

  • items[].typestringobrigatório

    Tipo de envio.

    whatsapp_litewhatsappsmsemailwebhookrcs

  • items[].statusstringobrigatório

    Status.

    pendingprocessingsendingcompletedcanceledpausederror

  • items[].destinationstring | nullobrigatório

    Para quem envia: contato ou usuário da conta.

    contactusernull

  • items[].fontstring | nullobrigatório

    Origem da automação.

    automationFlowinboxcontactnull

  • items[].manualboolean | nullobrigatório

    Disparo manual (true) ou por gatilho.

  • items[].activeboolean | nullobrigatório

    Ativa.

  • items[].business_hourboolean | nullobrigatório

    Respeita o horário comercial.

  • items[].create_ticketboolean | nullobrigatório

    Cria tíquete ao enviar.

  • items[].start_atstring (date-time) | nullobrigatório

    Início programado.

  • items[].end_atstring (date-time) | nullobrigatório

    Fim.

  • items[].totalinteger | nullobrigatório

    Total de envios.

  • items[].pendinginteger | nullobrigatório

    Pendentes.

  • items[].sendinginteger | nullobrigatório

    Enviando.

  • items[].errorinteger | nullobrigatório

    Com erro.

  • items[].deliveredinteger | nullobrigatório

    Entregues.

  • items[].readinteger | nullobrigatório

    Lidas.

  • items[].repliedinteger | nullobrigatório

    Respondidas.

  • items[].avg_seconds_to_readinteger | nullobrigatório

    Tempo médio até a leitura, em segundos.

  • items[].avg_seconds_to_replyinteger | nullobrigatório

    Tempo médio até a resposta, em segundos.

  • items[].metrics_synced_atstring (date-time) | nullobrigatório

    Última atualização dos contadores.

  • items[].created_atstring (date-time)obrigatório

    Criação.

  • items[].updated_atstring (date-time)obrigatório

    Última atualização.

  • items[].templatesobjectobrigatório

    Modelo enviado.

  • items[].templates.idstring (uuid)obrigatório

    ID do modelo.

  • items[].templates.namestringobrigatório

    Nome.

  • items[].templates.internal_namestringobrigatório

    Nome interno (o da Meta).

  • items[].channelsobjectobrigatório

    Canal resumido.

  • items[].channels.idstring (uuid)obrigatório

    ID do canal.

  • items[].channels.namestringobrigatório

    Nome do canal.

  • items[].channels.typestringobrigatório

    Tipo do canal.

    whatsappwhatsapp_litesmsemailwebhookchatinstagramrcs

  • items[].campaignsobject | nullobrigatório

    Campanha, se houver.

  • items[].campaigns.idstring (uuid)obrigatório

    ID.

  • items[].campaigns.namestring | nullobrigatório

    Nome.

  • items[].usersobjectobrigatório

    Usuário resumido (só nome).

  • items[].users.idstring (uuid)obrigatório

    ID do usuário.

  • items[].users.namestringobrigatório

    Nome.

  • totalintegerobrigatório

    Total de registros que casam com os filtros (todas as páginas).

  • pageintegerobrigatório

    Página devolvida (começa em 1).

  • limitintegerobrigatório

    Itens por página efetivamente usados (1–100).

  • pagesintegerobrigatório

    Total de páginas: `max(1, ceil(total / limit))`. Nunca é 0, mesmo sem resultados.

400Parâmetro de data (`from`, `to`, `updated_from`, `updated_to`) fora do formato ISO 8601.

403Acesso negado: usuário do token sem a permissão da rota (`permission_denied`) ou token não ligado a um usuário ativo (`token_without_user`) — para token de integração da conta isso só é aplicado quando `access.enforced` é true (veja GET /v1/me); token pessoal e JWT de sessão são sempre verificados; `account_id` na query diferente da conta do token; conta do tipo INFRA.

498Token ausente, inválido, de outra finalidade (ex.: token do canal chat) ou revogado. Note o status não padrão 498.