PicChat

Propriedades

Consultar propriedade

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

Devolve uma propriedade (da conta ou padrão da plataforma) com tipo, grupo e opções. O código busca por ID ou por internal_name.

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

Parâmetros de caminho

  • idstringobrigatório

    UUID da propriedade ou seu `internal_name` (ex.: `curso_interesse`).

Respostas

200OK

  • idstring (uuid)obrigatório

    ID da propriedade.

  • namestringobrigatório

    Nome exibido.

  • internal_namestringobrigatório

    Nome interno (chave usada nos contatos).

  • descriptionstring | nullobrigatório

    Descrição.

  • maskstring | nullobrigatório

    Máscara de entrada.

  • account_idstring (uuid) | nullobrigatório

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

  • created_atstring (date-time)obrigatório

    Criação.

  • type_propertiesobjectobrigatório

    Tipo da propriedade.

  • type_properties.idstring (uuid)obrigatório

    ID do tipo.

  • type_properties.namestring | nullobrigatório

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

  • type_properties.internalNamestring | nullobrigatório

    Tipo interno.

    textlongTextnumbermoneydatedatetimeselectnull

  • property_groupsobjectobrigatório

    Grupo da propriedade.

  • property_groups.idstring (uuid)obrigatório

    ID do grupo.

  • property_groups.namestringobrigatório

    Nome do grupo.

  • options_propertyarray<object>obrigatório

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

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

    ID da opção.

  • options_property[].namestringobrigatório

    Nome da opção.

  • options_property[].internal_namestringobrigatório

    Nome interno da opção.

  • defaultbooleanobrigatório

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

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.