> For the complete documentation index, see [llms.txt](https://docs.sprinthub.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sprinthub.com/topicos/api/api-obtendo-objetos-customizados-do-lead.md).

# API - Obtendo Objetos Customizados do Lead

Como puxar os objetos customizados de um Lead.

### Rota

<mark style="color:green;">`GET`</mark> `/lead/customobjects/id-do-lead?apitoken=seu-token&i=sua-instancia`

Endpoint completo: <mark style="color:green;"><https://sprinthub-api-master.sprinthub.app/lead/customobjects/id-do-lead?apitoken=seu-token\\&i=sua-instancia></mark>

### Query Params

<table><thead><tr><th width="291">Key/Chave</th><th width="450">Descrição</th></tr></thead><tbody><tr><td>i</td><td>Identificador da sua instância, subdomínio.</td></tr><tr><td>apitoken</td><td>Token da API.</td></tr></tbody></table>

## Obtendo Objetos Customizados do Lead

O envio da requisição foi feito utilizando o software *Postman*. A resposta esperada é uma lista de objetos com todos os Objetos Customizados.

<figure><img src="https://3534414179-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FzUKkagBNy5uQ7AtGNa%2Fuploads%2FCwIdzNd3JiMJ1TwJWH0m%2Fobjetos-1.png?alt=media&amp;token=a5633d69-bf8f-45e7-93e3-c5e06501a3c9" alt=""><figcaption><p><em>Objeto "Pedidos de Suporte".</em></p></figcaption></figure>

<figure><img src="https://3534414179-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FzUKkagBNy5uQ7AtGNa%2Fuploads%2FU1H8k8emQpI46SKcEaMV%2Fobjetos-2.png?alt=media&amp;token=ab9c2df0-2b77-4d66-8e24-4da89bb23839" alt=""><figcaption><p><em>Resposta da requisição.</em></p></figcaption></figure>

### Obtendo a definição dos Objetos Customizados

A resposta da chamada anterior retorna o "*definitionId*", que é o identificador do Objeto Customizado da instância, para obter uma lista das definições, pode ser utilizada a seguinte chamada:

<mark style="color:green;">`GET`</mark> `/customobjects/def?query={definitions{id,name,pluralName,relationship{id},isPublished,allowDynamicInsert,fields{label,alias,defaultValue,type,required,uniqueIdentifier,properties}}}&apitoken=seu-token&i=sua-instancia`

Endpoint completo: <mark style="color:green;"><https://sprinthub-api-master.sprinthub.app/customobjects/def?query={definitions{id,name,pluralName,relationship{id},isPublished,allowDynamicInsert,fields{label,alias,defaultValue,type,required,uniqueIdentifier,properties\\}}}\\&apitoken=seu-token\\&i=sua-instancia></mark>

<figure><img src="https://3534414179-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FzUKkagBNy5uQ7AtGNa%2Fuploads%2FLyHzqhV8CNLaHtLyrK1S%2Fobjetos-3.png?alt=media&amp;token=6c4f6fc4-30ab-4453-b819-01995ab3123b" alt=""><figcaption><p><em>Obtendo definições dos Objetos.</em></p></figcaption></figure>