GET /v1/contacts/custom-fields/{id}/usage
GET
/v1/contacts/custom-fields/{id}/usage
const url = 'https://seu-endereco-da-api/v1/contacts/custom-fields/example/usage';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://seu-endereco-da-api/v1/contacts/custom-fields/example/usage \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Gerenciar campos personalizados (contacts:fields).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Responses
Seção intitulada “Responses”Media typeapplication/json
object
records
required
Registros da entidade do campo (contatos, empresas ou negocios) com valor preenchido nele, contados ate o teto da base
number
capped
required
Ha mais registros preenchidos do que o teto da base: records e o teto
boolean
Example generated
{ "records": 1, "capped": true}