PicChat

Propriedades

Listar propriedades

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

Lista as propriedades de contato visíveis para a conta: as próprias e as padrão da plataforma (default: true), com tipo, grupo e opções. Ordem fixa: as padrão da plataforma primeiro, depois as da conta, cada bloco por nome; não aceita order.

Autenticação: Bearer tokenPermissão: Propriedades › ver ou Contatos › 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.

  • searchstring

    Busca parcial em `name` ou `internal_name`, sem diferenciar maiúsculas.

  • typestring

    Tipo da propriedade (`internalName` do tipo).

  • group_idstring (uuid)

    Só propriedades deste grupo.

Respostas

200OK

  • itemsarray<Property>obrigatório

    Registros da página.

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

    ID da propriedade.

  • items[].namestringobrigatório

    Nome exibido.

  • items[].internal_namestringobrigatório

    Nome interno (chave usada nos contatos).

  • items[].descriptionstring | nullobrigatório

    Descrição.

  • items[].maskstring | nullobrigatório

    Máscara de entrada.

  • items[].account_idstring (uuid) | nullobrigatório

    Conta dona. null = propriedade padrão da plataforma.

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

    Criação.

  • items[].type_propertiesobjectobrigatório

    Tipo da propriedade.

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

    ID do tipo.

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

    Nome do tipo (ex.: Texto, Menu suspenso).

  • items[].type_properties.internalNamestring | nullobrigatório

    Tipo interno.

    textlongTextnumbermoneydatedatetimeselectnull

  • items[].property_groupsobjectobrigatório

    Grupo da propriedade.

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

    ID do grupo.

  • items[].property_groups.namestringobrigatório

    Nome do grupo.

  • items[].options_propertyarray<object>obrigatório

    Opções (só em propriedades de select), por nome. Opções excluídas ficam de fora.

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

    ID da opção.

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

    Nome da opção.

  • items[].options_property[].internal_namestringobrigatório

    Nome interno da opção.

  • items[].defaultbooleanobrigatório

    true = propriedade padrão da plataforma (account_id null), visível a todas as contas.

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