v1Recursos/Custom Fields/getObter os valores de campos personalizados de uma entidade

Obter os valores de campos personalizados de uma entidade

Retorna os valores de campos personalizados armazenados em um local ou cliente, indexados pela key do campo.

get/api/v1/custom-fields/values

custom-fields:read

Parâmetros de consulta

entityTypestring (location | client)obrigatório

O tipo da entidade: "location" ou "client".

entityIdstringobrigatório

ID do local ou cliente para o qual ler os valores.

Resposta

dataobjectopcional

valuesobjectopcional

Os valores de campos personalizados da entidade, indexados pela key do campo. Um valor é uma string, um número, um array de strings (para multi_select), ou ausente quando não definido.

Erros

400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.

401Chave de API ausente, inválida, expirada ou revogada.

403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.

404O recurso não foi encontrado, ou não pertence à sua agência.

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

get/api/v1/custom-fields/values

Sua chave de API

entityType *

entityId *

{
  "data": {
    "values": {
      "parking_notes": "Free lot behind the building."
    }
  }
}