PicChat

Contatos

Consultar contato

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

Devolve um contato pelo ID, sempre com as propriedades preenchidas (properties e properties_detail), o total de tíquetes e as listas em que ele está. Contato excluído responde 404.

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

Parâmetros de caminho

  • idstring (uuid)obrigatório

    UUID do contato.

Respostas

200OK

  • idstring (uuid)obrigatório

    ID do contato.

  • first_namestring | nullobrigatório

    Nome.

  • last_namestring | nullobrigatório

    Sobrenome.

  • emailstring | nullobrigatório

    E-mail.

  • mobilephonestring | nullobrigatório

    Telefone só com dígitos, com DDI (ex.: 5511999990000).

  • statusstring | nullobrigatório

    Status livre do contato.

  • is_marketingboolean | nullobrigatório

    Aceita comunicação de marketing.

  • opt_outboolean | nullobrigatório

    Pediu para não receber mais mensagens.

  • invalid_numberboolean | nullobrigatório

    Número marcado como inválido (sem WhatsApp ou rejeitado pela Meta).

  • is_groupboolean | nullobrigatório

    É um grupo de WhatsApp.

  • userNamestring | nullobrigatório

    Usuário do Instagram.

  • fontstringobrigatório

    Fonte original do contato.

    referralsorganic_searchofflinesocial_mediapaid_searchpaid_socialemail_marketingother_campaignsdirect_trafficdirect_insertionimportation

  • descriptionstring | nullobrigatório

    Descrição/observação.

  • created_atstring (date-time)obrigatório

    Criação.

  • updated_atstring (date-time)obrigatório

    Última atualização.

  • propertiesobjectobrigatório

    Mapa `internal_name → valor` das propriedades preenchidas.

  • properties_detailarray<ContactPropertyValue>obrigatório

    Mesmas propriedades, com nome, tipo e data.

  • properties_detail[].property_idstring (uuid)obrigatório

    ID da propriedade.

  • properties_detail[].namestringobrigatório

    Nome da propriedade.

  • properties_detail[].internal_namestringobrigatório

    Nome interno (chave usada em `properties` e no filtro `property.<internal_name>`).

  • properties_detail[].typestring | nullobrigatório

    Tipo da propriedade (`internalName` do tipo: text, select, date...).

  • properties_detail[].valuestring | nullobrigatório

    Valor. Para propriedades de opção (select), é o nome da opção.

  • properties_detail[].option_internal_namestring | nullobrigatório

    internal_name da opção escolhida (só em select).

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

    Quando o valor foi gravado.

  • tickets_countintegerobrigatório

    Total de tíquetes do contato.

  • listsarray<object>obrigatório

    Listas em que o contato está (vínculos não excluídos).

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

    ID da lista.

  • lists[].namestringobrigatório

    Nome da lista.

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.