PicChat

Listas

Consultar lista

GEThttps://api.picchat.com.br/v1/lists/{id}

Devolve uma lista de contatos pelo ID, com quem criou e o total atual de contatos. Lista excluída responde 404.

Autenticação: Bearer tokenPermissão: Listas › ver

Parâmetros de caminho

  • idstring (uuid)obrigatório

    UUID da lista.

Respostas

200OK

  • idstring (uuid)obrigatório

    ID da lista.

  • namestringobrigatório

    Nome.

  • descriptionstring | nullobrigatório

    Descrição.

  • typestringobrigatório

    Tipo: estática, dinâmica (por filtros) ou importada.

    staticdynamicimport

  • statusstringobrigatório

    Status de processamento.

    pendingcompletedprocessing

  • filtersanyobrigatório

    Filtros da lista dinâmica (JSON livre, pode ser null).

  • last_synced_atstring (date-time) | nullobrigatório

    Última sincronização (listas dinâmicas).

  • created_atstring (date-time)obrigatório

    Criação.

  • updated_atstring (date-time)obrigatório

    Última atualização.

  • usersobjectobrigatório

    Usuário resumido (só nome).

  • users.idstring (uuid)obrigatório

    ID do usuário.

  • users.namestringobrigatório

    Nome.

  • contacts_countintegerobrigatório

    Contatos na lista agora (calculado na leitura, ignora vínculos excluídos).

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.

404Registro não existe, é de outra conta, foi excluído ou está fora do escopo de canais do usuário.

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