PicChat

Usuários

Listar usuários

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

Lista os usuários da conta — os de origem e os vinculados de outras contas (multi-conta) — em ordem alfabética, com os canais desta conta a que cada um está ligado. status é sempre o desta conta (para vinculados, o do vínculo). Não aceita order.

Autenticação: Bearer tokenPermissão: Usuários › 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.

  • statusstring

    Status nesta conta (igualdade exata, ex.: `active`, `inactive`).

  • onlineboolean

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

  • searchstring

    Busca parcial em nome, sobrenome e e-mail, sem diferenciar maiúsculas.

Respostas

200OK

  • itemsarray<User>obrigatório

    Registros da página.

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

    ID do usuário.

  • items[].namestringobrigatório

    Nome.

  • items[].lastNamestring | nullobrigatório

    Sobrenome.

  • items[].emailstringobrigatório

    E-mail.

  • items[].mobilephonestringobrigatório

    Celular.

  • items[].jobstring | nullobrigatório

    Cargo.

  • items[].statusstringobrigatório

    Status NESTA conta (ex.: active, inactive). Para usuário vinculado de outra conta, é o status do vínculo.

  • items[].onlineboolean | nullobrigatório

    Está online na inbox.

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

    Último login.

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

    Criação.

  • items[].channelsarray<ChannelRefShort>obrigatório

    Canais desta conta a que o usuário está vinculado.

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

    ID do canal.

  • items[].channels[].namestringobrigatório

    Nome do canal.

  • items[].financial_accessboolean

    Só aparece para usuário vinculado de outra conta (multi-conta): acesso financeiro nesta conta.

  • 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.

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.