API Apresenta.me

Introdução

Base URL: https://api.apresenta.me

Esta documentação serve para fornecer todas as informações de que você precisa para trabalhar com a API da Apresenta.me.

Autenticando Requisições

Para autenticar as requisições, inclua um cabeçalho Authorization com o valor "Bearer {YOUR_AUTH_KEY}".

Todos os recursos de API que necessitam de autenticação, estarão marcados com o selo requires authentication na documentação abaixo.

Rate Limit

Nossa API limita as requisições por minuto, caso você atinja esse limite, você receberá um retorno de erro com a mensagem Too Many Attempts.. Você pode checar quanto tempo em segundos é necessário aguardar lendo a header Retry-After.

Consultas e Manipulação de Dados

Nesta seção, você aprenderá como utilizar os parâmetros de busca e filtros disponíveis na API para personalizar e refinar os resultados retornados. Essas funcionalidades permitem localizar de maneira eficiente dados específicos, aplicando critérios de pesquisa detalhados.

A API oferece suporte a filtros por campos específicos, operadores condicionais (como igualdade, maior/menor que, entre outros), e consultas de texto. Combinando múltiplos filtros, é possível realizar pesquisas avançadas para obter apenas os dados relevantes ao seu contexto.

Além disso, será explicado como trazer relacionamentos nas buscas, permitindo que você inclua dados relacionados em suas consultas, como informações associadas a modelos vinculados. Isso possibilita a recuperação de informações completas e otimizadas, sem a necessidade de múltiplas requisições.

Nos exemplos a seguir, você encontrará instruções sobre como estruturar as requisições, os parâmetros suportados e como manipular relacionamentos para enriquecer as respostas da API.

Buscas

A API oferece a possibilidade de retornar apenas os campos que você deseja, utilizando o parâmetro fields. Dessa forma, você pode limitar os dados recebidos, otimizando a performance e o volume de informações trafegadas. Para especificar os campos que deseja, basta utilizar o parâmetro fields na URL da requisição.

Por exemplo: {API_URL}?fields=id,name,phone,email

No exemplo acima, a resposta incluirá apenas os campos id, name, phone e email do recurso solicitado.

Relacionamentos

Além de buscar campos específicos, você pode trazer dados de relacionamentos associados a um recurso, utilizando o parâmetro include. Isso é útil quando você precisa de informações vinculadas a outros modelos na mesma consulta.

Por exemplo, se você deseja trazer os detalhes de uma origem (origin_id) associado a um recurso, pode fazer da seguinte forma: {API_URL}?fields=id,name,phone,email&include[origin]=id,description,created_at

Aqui, a resposta incluirá os campos id, name, phone, email do recurso principal, e também os campos id, description, e created_at do relacionamento origin.

É importante ressaltar que os relacionamentos diretos, não exigem que seja retornado a chave do relacionamento, mas para relacionamentos mais internos, é imprescindível o retorno da chave do relacionamento para seja retornado pela API as informações conforme solicitadas. Veja os exemplos abaixo:

Imagine que você queira retornar apenas os campos: código interno, nome e o código e título do imóvel relacionado ao Lead, a URL da sua requisição ficaria algo como:

{API_URL}/persons/leads?fields=id,name&include[building]=id,title

Note que não foi necessário informar junto no parâmetro fields o campo building_id, mas caso você queira retornar os dados bairro desse imóvel por exemplo, você teria que informar a chave do relacionamento district_id entre o imóvel e bairro, pois a informação bairro. Veja como ficaria nesse caso:

{API_URL}/persons/leads?fields=id,name&include[building]=id,title,district_id&include[building.district]=id,name

Descrição: Este endpoint retorna informações sobre leads, incluindo detalhes do imóvel (building) e do bairro (district).

Comportamento: Se o parâmetro district_id não for informado na inclusão do relacionamento building, o retorno do relacionamento building.district será vazio, pois a API não consegue identificar a chave do relacionamento, que é o district_id.

Outra forma de realizar a busca dessas informações do bairro do imóvel:

{API_URL}/persons/leads?fields=id,name,building_id&include[building.district]=id,name

Descrição: Este endpoint busca informações sobre leads e permite incluir diretamente o relacionamento building.district sem a necessidade de incluir previamente building.

Comportamento: Ao chamar include[building.district], a API retorna todas as informações do building juntamente com os dados solicitados do district. Neste caso, note que é necessário trazer a informação building_id no parâmetro fields, para que a API consiga mapear os relacionamentos e retornar corretamente os dados solicitados.

Notas:

O uso do parâmetro include para trazer relacionamentos não depende necessariamente do uso de fields. Você pode incluir relacionamentos sem limitar os campos retornados do recurso principal.
Os campos e relacionamentos disponíveis para uso nas buscas e filtros serão exibidos em cada recurso da API. Cada endpoint terá sua própria lista de campos e relacionamentos que podem ser utilizados nas requisições, permitindo que você personalize as respostas conforme necessário.

Campos Customizados

Além de buscar campos específicos, você pode trazer dados de relacionamentos associados aos campos customizados, utilizando o parâmetro customFields com o valor true. Isso é útil quando você precisa de informações vinculadas em campos customizados. Os campos que forem customizados irão retornar com o prefixo _ (underline).

Para isso basta você fazer a seguinte utilização:

{API_URL}/building?customFields=true

Filtros

A API permite que você refine suas buscas utilizando parâmetros de filtro para restringir os resultados de acordo com critérios específicos. Os filtros podem ser aplicados a diversos campos e suportam diferentes operadores, como igualdade, "contém", e intervalos de datas, entre outros.

Operadores disponíveis:

Igual: para buscar valores exatos, utilize:
filter[name]=Exemplo
Diferente: para buscar valores diferentes, você pode usar not_equal ou ne:
filter[name|not_equal]=Exemplo ou filter[name|ne]=Exemplo
Menor que: para buscar valores menores que um determinado valor less ou l:
filter[age|less]=30 ou filter[age|l]=30
Maior que: para buscar valores maiores que um determinado valor, você pode usar greater ou g:
filter[age|greater]=30 ou filter[age|g]=30
Entre: para buscar valores em um intervalo, como datas, use o operador between ou b:
filter[created_at|between]=2024-01-01|2024-02-01 ou filter[created_at|b]=2024-01-01|2024-02-01
Não Entre: para filtrar valores que não estão em um intervalo, utilize not_between ou nb:
filter[created_at|not_between]=2024-01-01|2024-02-01
Nulo ou Vazio: para buscar valores que sejam nulos ou vazios, utilize empty:
filter[gender|empty]

Esses operadores permitem que você especifique de forma flexível os critérios de filtragem nas suas requisições. Ao combinar diferentes filtros, você pode refinar ainda mais os resultados de acordo com suas necessidades. Outros operadores que podem ser utilizados: greater_or_equal/ge (maior ou igual), less_or_equal/le (menor ou igual), not_empty (não nulo ou não vazio).

Filtros Especiais

Além dos operadores de filtro padrão, o sistema oferece filtros especiais para casos comuns de uso. Estes filtros são pré-configurados para facilitar buscas frequentes.

Filtros com Múltiplos Valores

Alguns filtros permitem buscar por múltiplos valores ao mesmo tempo. Por exemplo, para buscar contratos de diferentes tipos ou status, você pode usar:

/financial/contracts?filter[typeIn][]=rent&filter[typeIn][]=sale

Ou usando índices:

/financial/contracts?filter[typeIn][0]=rent&filter[typeIn][1]=sale

Exemplos de Uso

Buscar contratos ativos:

/financial/contracts?filter[active]=active

Buscar contratos por tipo (locação, venda ou temporada):

/financial/contracts?filter[typeIn][]=rent&filter[typeIn][]=sale

Buscar contratos de múltiplos imóveis:

/financial/contracts?filter[buildingIn][]=1&filter[buildingIn][]=2&filter[buildingIn][]=3

Buscar contratos por status de pagamento:

/financial/contracts?filter[paymentStatusIn][]=ok&filter[paymentStatusIn][]=due_5_days

Buscar contratos por proprietário:

/financial/contracts?filter[ownerIn][]=1&filter[ownerIn][]=2

Observações Importantes

Para filtros que aceitam múltiplos valores, você pode usar qualquer uma das notações de array mostradas acima
Você pode combinar diferentes filtros em uma única requisição
A ordem dos parâmetros não importa
Os valores dos filtros são case-sensitive (maiúsculas e minúsculas importam)

Ordenação e Paginação de Resultados

Nesta seção, você aprenderá como utilizar recursos de ordenação e paginação para organizar e limitar os dados retornados pela API. Esses mecanismos são essenciais para otimizar a apresentação dos resultados, especialmente ao lidar com grandes volumes de informações.

Ordenando

Para ordenar os dados retornados pela API, basta utilizar o query parameter sort seguido do nome da coluna pela qual deseja ordenar. Por exemplo:

Para ordenar por nome, use: ?sort=nome
Para ordenar por data de criação, use: ?sort=data_criacao

Se quiser reverter a ordem para descendente, basta adicionar um sinal de menos antes do nome da coluna:

?sort=-nome ordenará os nomes de forma decrescente.
?sort=-data_criacao ordenará as datas da mais recente para a mais antiga.

Além disso, é possível combinar múltiplas colunas para uma ordenação mais complexa. Para isso, você pode separar os nomes das colunas com vírgulas. Por exemplo:

Para ordenar primeiro por nome e depois por data de criação, use: ?sort=nome,data_criacao
Para ordenar por data de criação de forma decrescente e, em seguida, por nome de forma ascendente, use: ?sort=-data_criacao,nome

Dessa forma, você tem total controle sobre a organização dos resultados retornados pela API.

Paginando

Nosso sistema implementa um padrão de retorno para as buscas que inclui informações sobre a paginação. O retorno terá a seguinte estrutura:

{
    "return": true,
    "status": 200,
    "current_page": 1,
    "first_page_url": "/?page=1",
    "next_page_url": "/?page=2",
    "path": "/",
    "per_page": 10,
    "prev_page_url": null,
    "from": 1,
    "to": 10,
    "data": [
        // Retorno das informações
    ]
}

Neste exemplo, você pode observar os seguintes campos importantes:

current_page: a página atual que está sendo exibida.
first_page_url: URL para a primeira página.
next_page_url: URL para a próxima página.
prev_page_url: URL para a página anterior (pode ser null se você estiver na primeira página).
per_page: quantos itens são retornados por página.
from e to: intervalo de itens exibidos na página atual.

Para personalizar a quantidade de itens retornados por página, você pode usar o parâmetro de query perPage. Por exemplo:

Para retornar 20 itens por página, use: ?perPage=20

Além disso, você pode utilizar o parâmetro page para especificar qual página deseja acessar. Por exemplo:

Para acessar a segunda página, use: ?page=2

Classificação dos Imóveis

Tipos de Imóveis

Pesquisar

GET

https://api.apresenta.me/buildings/types

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description

filter[id]

integer

ID do tipo de imóvel.

Example:

123456

filter[description]

string

Descrição do tipo de imóvel.

Example:

%Apartamento%

filter[category_id]

integer

ID da categoria do tipo de imóvel.

Example:

include[category]

string

Retorna os dados da categoria do tipo de imóvel.

Example:

id,description

include[buildings]

string

Retorna os dados dos imóveis relacionados ao tipo de imóvel.

Example:

id,title

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/types?sort=id&fields=id%2Cdescription&filter%5Bid%5D=123456&filter%5Bdescription%5D=%25Apartamento%25&filter%5Bcategory_id%5D=1&include%5Bcategory%5D=id%2Cdescription&include%5Bbuildings%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/buildings/types

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

description

required

string Descrição do tipo de imóvel.

Example:

fazenda

category_id

integer

required

ID da Categoria.

Example:

Auth

Bearer

Headers

Body

{ "description": "fazenda", "category_id": 1 }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/buildings/types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"fazenda\",
    \"category_id\": 1
}"

Obter

GET

https://api.apresenta.me/buildings/types/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Tipo de Imóvel.

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description

include[category]

string

Retorna os dados da categoria do tipo de imóvel.

Example:

id,description

include[buildings]

string

Retorna os dados dos imóveis relacionados ao tipo de imóvel.

Example:

id,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/types/5?sort=id&fields=id%2Cdescription&include%5Bcategory%5D=id%2Cdescription&include%5Bbuildings%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/buildings/types/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Tipo de Imóvel.

Example:

Body Parameters

description

string

Descrição do Tipo de Imóvel.

Example:

Apartamento

category_id

integer

ID da Categoria.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "description": "Apartamento", "category_id": 1 }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/buildings/types/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Apartamento\",
    \"category_id\": 1
}"

Excluir

DELETE

https://api.apresenta.me/buildings/types/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Tipo de Imóvel.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/buildings/types/5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Categorias

Pesquisar

GET

https://api.apresenta.me/buildings/categories

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description

filter[id]

integer

ID da categoria.

Example:

filter[description]

string

Descrição da categoria.

Example:

Rural

filter[color]

string

Cor da categoria.

Example:

0000FF

include[types]

string

Retorna todos os tipos de imóveis relacionados à categoria.

Example:

id,description

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/categories?sort=id&fields=id%2Cdescription&filter%5Bid%5D=1&filter%5Bdescription%5D=Rural&filter%5Bcolor%5D=0000FF&include%5Btypes%5D=id%2Cdescription" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/buildings/categories

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

description

string

required

Descrição da categoria.

Example:

Rural

color

string

required

Cor da categoria.

Example:

0000FF

Auth

Bearer

Headers

Body

{ "description": "Rural", "color": "0000FF" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/buildings/categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Rural\",
    \"color\": \"0000FF\"
}"

Obter

GET

https://api.apresenta.me/buildings/categories/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da categoria.

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description

include[types]

string

Retorna todos os tipos de imóveis relacionados à categoria.

Example:

id,description

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/categories/12?sort=id&fields=id%2Cdescription&include%5Btypes%5D=id%2Cdescription" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/buildings/categories/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da categoria.

Example:

Body Parameters

description

string

Descrição da categoria.

Example:

Rural

color

string

Cor da categoria.

Example:

0000FF

Auth

Bearer

Headers

URL Parameters

Body

{ "description": "Rural", "color": "0000FF" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/buildings/categories/11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Rural\",
    \"color\": \"0000FF\"
}"

Excluir

DELETE

https://api.apresenta.me/buildings/categories/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da categoria.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/buildings/categories/15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Condomínios

Excluir grupo do condomínio

DELETE

https://api.apresenta.me/condominiums/groups/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Grupo do Condomínio

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/condominiums/groups/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Pesquisar

GET

https://api.apresenta.me/condominiums

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros.

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta.

Example:

id,id2,title

filter[id]

integer

ID do condomínio.

Example:

filter[id2]

integer

ID visível do condomínio.

Example:

filter[mode]

string

Modo (condomínio ou lançamento).

Example:

release

filter[status]

string

Status.

Example:

active

filter[lock]

string

Status.

Example:

active

filter[type_id]

integer

ID da Subcategoria/Tipo do condomínio.

Example:

filter[stage_id]

integer

ID do estágio.

Example:

filter[country_id]

integer

ID do País.

Example:

filter[state_id]

integer

ID do estado.

Example:

filter[city_id]

integer

ID da cidade.

Example:

filter[district_id]

integer

ID do bairro

Example:

filter[tag]

integer[]

Tags.

Example:

[13,11,12]

filter[responsible]

integer[]

Corretores responsáveis.

Example:

[123,132]

filter[constructor_id]

integer

ID da construtora.

Example:

filter[access]

string

Tipo de Acesso.

Example:

all

filter[pickup]

integer[]

Corretores captadores.

Example:

[1123,1322]

filter[slug]

string

Link permanente para site.

Example:

exemplo-perma-link

filter[updated_by]

integer

ID do usuário que atualizou.

Example:

filter[created_by]

integer

ID do usuário que cadastrou.

Example:

filter[principal_media]

string

Mídia principal.

Example:

aspernatur

filter[built_year]

integer

Ano de construção.

Example:

filter[total_floors]

integer

Quantidade de andares.

Example:

filter[total_by_floor]

integer

Quantidade de unidades por andar.

Example:

filter[blocks]

integer

Quantidade de Blocos do condomínio.

Example:

filter[title]

string

Titulo do condomínio.

Example:

Título Exemplar

filter[content]

string

HTML do conteúdo da descrição.

Example:

Condomínio de frente para o mar...

filter[lock_description]

string

Motivo do bloqueio.

Example:

Bloqueado para atualização

filter[street]

string

Rua do condomínio.

Example:

Rua Guanabara

filter[number]

integer

número do condomínio

Example:

filter[complement]

string

Complemento do condomínio.

Example:

Apartamento

filter[zip_code]

integer

CEP do condomínio.

Example:

filter[notes]

string

Observações.

Example:

vitae

filter[html_title]

string

Título da página (HTML title).

Example:

SEO Título

filter[html_keyword]

string

Palavras Chave (HTML Keyword).

Example:

condomínio,grupo,venda

filter[html_description]

string

descrição SEO.

Example:

SEO

include[buildings]

string

Imóveis do condomínio.

Example:

id,title,slug

include[purposes]

string

Finalidades do condomínio.

Example:

type,amount

include[groups]

string

Grupos do condomínio.

Example:

id,title

include[units]

string

Unidades do condomínio.

Example:

id,title

include[related]

string

Pessoas relacionadas ao condomínio.

Example:

id,title,slug

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/condominiums?sort=id&fields=id%2Cid2%2Ctitle&filter%5Bid%5D=5&filter%5Bid2%5D=8&filter%5Bmode%5D=release&filter%5Bstatus%5D=active&filter%5Block%5D=active&filter%5Btype_id%5D=6&filter%5Bstage_id%5D=12&filter%5Bcountry_id%5D=7&filter%5Bstate_id%5D=15&filter%5Bcity_id%5D=17&filter%5Bdistrict_id%5D=2&filter%5Btag%5D[]=13&filter%5Btag%5D[]=11&filter%5Btag%5D[]=12&filter%5Bresponsible%5D[]=123&filter%5Bresponsible%5D[]=132&filter%5Bconstructor_id%5D=13&filter%5Baccess%5D=all&filter%5Bpickup%5D[]=1123&filter%5Bpickup%5D[]=1322&filter%5Bslug%5D=exemplo-perma-link&filter%5Bupdated_by%5D=9&filter%5Bcreated_by%5D=7&filter%5Bprincipal_media%5D=aspernatur&filter%5Bbuilt_year%5D=20&filter%5Btotal_floors%5D=12&filter%5Btotal_by_floor%5D=8&filter%5Bblocks%5D=14&filter%5Btitle%5D=T%C3%ADtulo+Exemplar&filter%5Bcontent%5D=%3Cp%3ECondom%C3%ADnio+de+frente+para+o+mar...%3C%2Fp%3E&filter%5Block_description%5D=Bloqueado+para+atualiza%C3%A7%C3%A3o&filter%5Bstreet%5D=Rua+Guanabara&filter%5Bnumber%5D=12&filter%5Bcomplement%5D=Apartamento&filter%5Bzip_code%5D=3&filter%5Bnotes%5D=vitae&filter%5Bhtml_title%5D=SEO+T%C3%ADtulo&filter%5Bhtml_keyword%5D=condom%C3%ADnio%2Cgrupo%2Cvenda&filter%5Bhtml_description%5D=SEO&include%5Bbuildings%5D=id%2Ctitle%2Cslug&include%5Bpurposes%5D=type%2Camount&include%5Bgroups%5D=id%2Ctitle&include%5Bunits%5D=id%2Ctitle&include%5Brelated%5D=id%2Ctitle%2Cslug" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.apresenta.me/condominiums"
);

const params = {
    "sort": "id",
    "fields": "id,id2,title",
    "filter[id]": "5",
    "filter[id2]": "8",
    "filter[mode]": "release",
    "filter[status]": "active",
    "filter[lock]": "active",
    "filter[type_id]": "6",
    "filter[stage_id]": "12",
    "filter[country_id]": "7",
    "filter[state_id]": "15",
    "filter[city_id]": "17",
    "filter[district_id]": "2",
    "filter[tag][0]": "13",
    "filter[tag][1]": "11",
    "filter[tag][2]": "12",
    "filter[responsible][0]": "123",
    "filter[responsible][1]": "132",
    "filter[constructor_id]": "13",
    "filter[access]": "all",
    "filter[pickup][0]": "1123",
    "filter[pickup][1]": "1322",
    "filter[slug]": "exemplo-perma-link",
    "filter[updated_by]": "9",
    "filter[created_by]": "7",
    "filter[principal_media]": "aspernatur",
    "filter[built_year]": "20",
    "filter[total_floors]": "12",
    "filter[total_by_floor]": "8",
    "filter[blocks]": "14",
    "filter[title]": "Título Exemplar",
    "filter[content]": "<p>Condomínio de frente para o mar...</p>",
    "filter[lock_description]": "Bloqueado para atualização",
    "filter[street]": "Rua Guanabara",
    "filter[number]": "12",
    "filter[complement]": "Apartamento",
    "filter[zip_code]": "3",
    "filter[notes]": "vitae",
    "filter[html_title]": "SEO Título",
    "filter[html_keyword]": "condomínio,grupo,venda",
    "filter[html_description]": "SEO",
    "include[buildings]": "id,title,slug",
    "include[purposes]": "type,amount",
    "include[groups]": "id,title",
    "include[units]": "id,title",
    "include[related]": "id,title,slug",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/condominiums';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'sort' => 'id',
            'fields' => 'id,id2,title',
            'filter[id]' => '5',
            'filter[id2]' => '8',
            'filter[mode]' => 'release',
            'filter[status]' => 'active',
            'filter[lock]' => 'active',
            'filter[type_id]' => '6',
            'filter[stage_id]' => '12',
            'filter[country_id]' => '7',
            'filter[state_id]' => '15',
            'filter[city_id]' => '17',
            'filter[district_id]' => '2',
            'filter[tag][0]' => '13',
            'filter[tag][1]' => '11',
            'filter[tag][2]' => '12',
            'filter[responsible][0]' => '123',
            'filter[responsible][1]' => '132',
            'filter[constructor_id]' => '13',
            'filter[access]' => 'all',
            'filter[pickup][0]' => '1123',
            'filter[pickup][1]' => '1322',
            'filter[slug]' => 'exemplo-perma-link',
            'filter[updated_by]' => '9',
            'filter[created_by]' => '7',
            'filter[principal_media]' => 'aspernatur',
            'filter[built_year]' => '20',
            'filter[total_floors]' => '12',
            'filter[total_by_floor]' => '8',
            'filter[blocks]' => '14',
            'filter[title]' => 'Título Exemplar',
            'filter[content]' => '<p>Condomínio de frente para o mar...</p>',
            'filter[lock_description]' => 'Bloqueado para atualização',
            'filter[street]' => 'Rua Guanabara',
            'filter[number]' => '12',
            'filter[complement]' => 'Apartamento',
            'filter[zip_code]' => '3',
            'filter[notes]' => 'vitae',
            'filter[html_title]' => 'SEO Título',
            'filter[html_keyword]' => 'condomínio,grupo,venda',
            'filter[html_description]' => 'SEO',
            'include[buildings]' => 'id,title,slug',
            'include[purposes]' => 'type,amount',
            'include[groups]' => 'id,title',
            'include[units]' => 'id,title',
            'include[related]' => 'id,title,slug',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.apresenta.me/condominiums'
params = {
  'sort': 'id',
  'fields': 'id,id2,title',
  'filter[id]': '5',
  'filter[id2]': '8',
  'filter[mode]': 'release',
  'filter[status]': 'active',
  'filter[lock]': 'active',
  'filter[type_id]': '6',
  'filter[stage_id]': '12',
  'filter[country_id]': '7',
  'filter[state_id]': '15',
  'filter[city_id]': '17',
  'filter[district_id]': '2',
  'filter[tag][0]': '13',
  'filter[tag][1]': '11',
  'filter[tag][2]': '12',
  'filter[responsible][0]': '123',
  'filter[responsible][1]': '132',
  'filter[constructor_id]': '13',
  'filter[access]': 'all',
  'filter[pickup][0]': '1123',
  'filter[pickup][1]': '1322',
  'filter[slug]': 'exemplo-perma-link',
  'filter[updated_by]': '9',
  'filter[created_by]': '7',
  'filter[principal_media]': 'aspernatur',
  'filter[built_year]': '20',
  'filter[total_floors]': '12',
  'filter[total_by_floor]': '8',
  'filter[blocks]': '14',
  'filter[title]': 'Título Exemplar',
  'filter[content]': '<p>Condomínio de frente para o mar...</p>',
  'filter[lock_description]': 'Bloqueado para atualização',
  'filter[street]': 'Rua Guanabara',
  'filter[number]': '12',
  'filter[complement]': 'Apartamento',
  'filter[zip_code]': '3',
  'filter[notes]': 'vitae',
  'filter[html_title]': 'SEO Título',
  'filter[html_keyword]': 'condomínio,grupo,venda',
  'filter[html_description]': 'SEO',
  'include[buildings]': 'id,title,slug',
  'include[purposes]': 'type,amount',
  'include[groups]': 'id,title',
  'include[units]': 'id,title',
  'include[related]': 'id,title,slug',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/condominiums

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

integer

ID do condomínio.

Example:

id2

integer

ID visível do condomínio.

Example:

mode

string

required

Modo (condomínio ou lançamento).

Example:

release

status

string

required

Status.

Example:

active

lock

string

Status.

Example:

active

type_id

integer

required

ID da Subcategoria/Tipo do condomínio.

Example:

stage_id

integer

ID do estágio.

Example:

country_id

integer

ID do País.

Example:

state_id

integer

ID do estado.

Example:

city_id

integer

ID da cidade.

Example:

district_id

integer

ID do bairro

Example:

tag

integer[]

Tags.

Example:

[8]

responsible

integer[]

Corretores responsáveis.

Example:

[20]

constructor_id

integer

ID da construtora.

Example:

access

string

Tipo de Acesso.

Example:

all

pickup

integer[]

Corretores captadores.

Example:

[9]

slug

string

Link permanente para site.

Example:

exemplo-perma-link

updated_by

integer

ID do usuário que atualizou.

Example:

created_by

integer

ID do usuário que cadastrou.

Example:

principal_media

string

Mídia principal.

Example:

voluptatem

built_year

integer

Ano de construção.

Example:

total_floors

integer

Quantidade de andares.

Example:

total_by_floor

integer

Quantidade de unidades por andar.

Example:

blocks

integer

Quantidade de Blocos do condomínio.

Example:

title

string

required

Titulo do condomínio.

Example:

Título Exemplar

content

string

HTML do conteúdo da descrição.

Example:

Condomínio de frente para o mar...

lock_description

string

Motivo do bloqueio.

Example:

Bloqueado para atualização

street

string

Rua do condomínio.

Example:

Rua Guanabara

number

integer

número do condomínio

Example:

complement

string

Complemento do condomínio.

Example:

Apartamento

zip_code

integer

CEP do condomínio.

Example:

notes

string

Observações.

Example:

voluptate

html_title

string

Título da página (HTML title).

Example:

SEO Título

html_keyword

string

Palavras Chave (HTML Keyword). Example:

Example:

html_description

string

descrição SEO.

Example:

SEO,chave

groups

json

Grupos do condomínio.

Example:

[{"title": "Grupo A", "status": "active", "area_total_min": "150,00", "bathroom_min": "1", "bedroom_min": "2", "room_min": "1", "suite_min": "1", "purposes": [{"type": "sale", "amount": "150000", "condominium": "5000", "iptu_amount": "1500"}]}]

Auth

Bearer

Headers

Body

{ "id": 15, "id2": 20, "mode": "release", "status": "active", "lock": "active", "type_id": 6, "stage_id": 15, "country_id": 12, "state_id": 18, "city_id": 2, "district_id": 10, "tag": [ 8 ], "responsible": [ 20 ], "constructor_id": 2, "access": "all", "pickup": [ 9 ], "slug": "exemplo-perma-link", "updated_by": 7, "created_by": 9, "principal_media": "voluptatem", "built_year": 10, "total_floors": 4, "total_by_floor": 14, "blocks": 11, "title": "T\u00edtulo Exemplar", "content": "

Condom\u00ednio de frente para o mar...<\/p>", "lock_description": "Bloqueado para atualiza\u00e7\u00e3o", "street": "Rua Guanabara", "number": 11, "complement": "Apartamento", "zip_code": 12, "notes": "voluptate", "html_title": "SEO T\u00edtulo", "html_keyword": "in", "html_description": "SEO,chave", "groups": "[{\"title\": \"Grupo A\", \"status\": \"active\", \"area_total_min\": \"150,00\", \"bathroom_min\": \"1\", \"bedroom_min\": \"2\", \"room_min\": \"1\", \"suite_min\": \"1\", \"purposes\": [{\"type\": \"sale\", \"amount\": \"150000\", \"condominium\": \"5000\", \"iptu_amount\": \"1500\"}]}]" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/condominiums" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 15,
    \"id2\": 20,
    \"mode\": \"release\",
    \"status\": \"active\",
    \"lock\": \"active\",
    \"type_id\": 6,
    \"stage_id\": 15,
    \"country_id\": 12,
    \"state_id\": 18,
    \"city_id\": 2,
    \"district_id\": 10,
    \"tag\": [
        8
    ],
    \"responsible\": [
        20
    ],
    \"constructor_id\": 2,
    \"access\": \"all\",
    \"pickup\": [
        9
    ],
    \"slug\": \"exemplo-perma-link\",
    \"updated_by\": 7,
    \"created_by\": 9,
    \"principal_media\": \"voluptatem\",
    \"built_year\": 10,
    \"total_floors\": 4,
    \"total_by_floor\": 14,
    \"blocks\": 11,
    \"title\": \"Título Exemplar\",
    \"content\": \"<p>Condomínio de frente para o mar...<\\/p>\",
    \"lock_description\": \"Bloqueado para atualização\",
    \"street\": \"Rua Guanabara\",
    \"number\": 11,
    \"complement\": \"Apartamento\",
    \"zip_code\": 12,
    \"notes\": \"voluptate\",
    \"html_title\": \"SEO Título\",
    \"html_keyword\": \"in\",
    \"html_description\": \"SEO,chave\",
    \"groups\": \"[{\\\"title\\\": \\\"Grupo A\\\", \\\"status\\\": \\\"active\\\", \\\"area_total_min\\\": \\\"150,00\\\", \\\"bathroom_min\\\": \\\"1\\\", \\\"bedroom_min\\\": \\\"2\\\", \\\"room_min\\\": \\\"1\\\", \\\"suite_min\\\": \\\"1\\\", \\\"purposes\\\": [{\\\"type\\\": \\\"sale\\\", \\\"amount\\\": \\\"150000\\\", \\\"condominium\\\": \\\"5000\\\", \\\"iptu_amount\\\": \\\"1500\\\"}]}]\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/condominiums';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'id' => 15,
            'id2' => 20,
            'mode' => 'release',
            'status' => 'active',
            'lock' => 'active',
            'type_id' => 6,
            'stage_id' => 15,
            'country_id' => 12,
            'state_id' => 18,
            'city_id' => 2,
            'district_id' => 10,
            'tag' => [
                8,
            ],
            'responsible' => [
                20,
            ],
            'constructor_id' => 2,
            'access' => 'all',
            'pickup' => [
                9,
            ],
            'slug' => 'exemplo-perma-link',
            'updated_by' => 7,
            'created_by' => 9,
            'principal_media' => 'voluptatem',
            'built_year' => 10,
            'total_floors' => 4,
            'total_by_floor' => 14,
            'blocks' => 11,
            'title' => 'Título Exemplar',
            'content' => '<p>Condomínio de frente para o mar...</p>',
            'lock_description' => 'Bloqueado para atualização',
            'street' => 'Rua Guanabara',
            'number' => 11,
            'complement' => 'Apartamento',
            'zip_code' => 12,
            'notes' => 'voluptate',
            'html_title' => 'SEO Título',
            'html_keyword' => 'in',
            'html_description' => 'SEO,chave',
            'groups' => '[{"title": "Grupo A", "status": "active", "area_total_min": "150,00", "bathroom_min": "1", "bedroom_min": "2", "room_min": "1", "suite_min": "1", "purposes": [{"type": "sale", "amount": "150000", "condominium": "5000", "iptu_amount": "1500"}]}]',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Obter

GET

https://api.apresenta.me/condominiums/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do condomínio

Example:

Query Parameters

sort

string

Campo para ordenar os registros.

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta.

Example:

id,id2,title

include[buildings]

string

Imóveis do condomínio.

Example:

id,title,slug

include[purposes]

string

Finalidades do condomínio.

Example:

type,amount

include[groups]

string

Grupos do condomínio.

Example:

id,title

include[units]

string

Unidades do condomínio.

Example:

id,title

include[related]

string

Pessoas relacionadas ao condomínio.

Example:

id,title,slug

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/condominiums/1?sort=id&fields=id%2Cid2%2Ctitle&include%5Bbuildings%5D=id%2Ctitle%2Cslug&include%5Bpurposes%5D=type%2Camount&include%5Bgroups%5D=id%2Ctitle&include%5Bunits%5D=id%2Ctitle&include%5Brelated%5D=id%2Ctitle%2Cslug" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/condominiums/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Condomínio

Example:

Body Parameters

mode

string

Tipo do Empreendimento.

Example:

condominium

status

string

Status.

Example:

active

type_id

integer

ID da Subcategoria/Tipo do condomínio.

Example:

stage_id

integer

ID do estágio.

Example:

country_id

integer

ID do País.

Example:

state_id

integer

ID do estado.

Example:

city_id

integer

ID da cidade.

Example:

district_id

integer

ID do bairro

Example:

responsible

integer[]

IDs dos responsáveis

Example:

[7]

constructor_id

integer

ID da construtora.

Example:

access

string

Tipo de Acesso.

Example:

all

pickup

integer[]

IDs dos captadores do condomínio.

Example:

[3]

slug

string

Link permanente para site.

Example:

exemplo-perma-link

updated_by

integer

ID do usuário que atualizou.

Example:

created_by

integer

ID do usuário que cadastrou.

Example:

principal_media

string

Mídia principal.

Example:

iure

built_year

integer

Ano de construção.

Example:

2021

blocks

integer

Quantidade de Blocos do condomínio.

Example:

title

string

required

Titulo do condomínio.

Example:

Título Exemplar

street

string

Rua do condomínio.

Example:

Rua Guanabara

number

integer

número do condomínio

Example:

complement

string

Complemento do condomínio.

Example:

Apartamento

zip_code

integer

CEP do condomínio.

Example:

notes

string

Observações.

Example:

molestias

details

integer[]

Detalhes do condomínio.

Example:

[1083,1093]

groups

json

Grupos do condomínio.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "mode": "condominium", "status": "active", "type_id": 8, "stage_id": 16, "country_id": 7, "state_id": 5, "city_id": 16, "district_id": 13, "responsible": [ 7 ], "constructor_id": 2, "access": "all", "pickup": [ 3 ], "slug": "exemplo-perma-link", "updated_by": 19, "created_by": 12, "principal_media": "iure", "built_year": 2021, "blocks": 2, "title": "T\u00edtulo Exemplar", "street": "Rua Guanabara", "number": 16, "complement": "Apartamento", "zip_code": 7, "notes": "molestias", "details": [ 1083, 1093 ], "groups": "[{\"title\": \"Grupo A\", \"status\": \"active\", \"area_total_min\": \"150,00\", \"bathroom_min\": \"1\", \"bedroom_min\": \"2\", \"room_min\": \"1\", \"suite_min\": \"1\", \"purposes\": [{\"type\": \"sale\", \"amount\": \"150000\", \"condominium\": \"5000\", \"iptu_amount\": \"1500\"}]}]" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/condominiums/16" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"mode\": \"condominium\",
    \"status\": \"active\",
    \"type_id\": 8,
    \"stage_id\": 16,
    \"country_id\": 7,
    \"state_id\": 5,
    \"city_id\": 16,
    \"district_id\": 13,
    \"responsible\": [
        7
    ],
    \"constructor_id\": 2,
    \"access\": \"all\",
    \"pickup\": [
        3
    ],
    \"slug\": \"exemplo-perma-link\",
    \"updated_by\": 19,
    \"created_by\": 12,
    \"principal_media\": \"iure\",
    \"built_year\": 2021,
    \"blocks\": 2,
    \"title\": \"Título Exemplar\",
    \"street\": \"Rua Guanabara\",
    \"number\": 16,
    \"complement\": \"Apartamento\",
    \"zip_code\": 7,
    \"notes\": \"molestias\",
    \"details\": [
        1083,
        1093
    ],
    \"groups\": \"[{\\\"title\\\": \\\"Grupo A\\\", \\\"status\\\": \\\"active\\\", \\\"area_total_min\\\": \\\"150,00\\\", \\\"bathroom_min\\\": \\\"1\\\", \\\"bedroom_min\\\": \\\"2\\\", \\\"room_min\\\": \\\"1\\\", \\\"suite_min\\\": \\\"1\\\", \\\"purposes\\\": [{\\\"type\\\": \\\"sale\\\", \\\"amount\\\": \\\"150000\\\", \\\"condominium\\\": \\\"5000\\\", \\\"iptu_amount\\\": \\\"1500\\\"}]}]\"
}"

Excluir

DELETE

https://api.apresenta.me/condominiums/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Condomínio

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/condominiums/13" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Construtoras

Pesquisar

GET

https://api.apresenta.me/buildings/constructors

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name

filter[id]

integer

ID da construtora.

Example:

123456

filter[name]

string

Nome da construtora.

Example:

Construtora Teste

filter[state_id]

integer

Estado de atuação.

Example:

filter[notes]

string

Observações.

Example:

Observação

include[state]

string

Retorna os dados do Estado da construtora.

Example:

id,name,abbreviation

include[buildings]

string

Retorna os dados dos imóveis da construtora.

Example:

id,reference,title

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/constructors?sort=id&fields=id%2Cname&filter%5Bid%5D=123456&filter%5Bname%5D=Construtora+Teste&filter%5Bstate_id%5D=24&filter%5Bnotes%5D=Observa%C3%A7%C3%A3o&include%5Bstate%5D=id%2Cname%2Cabbreviation&include%5Bbuildings%5D=id%2Creference%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/buildings/constructors

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Nome da construtora.

Example:

Construtora Exemplo

state_id

integer

estado de atuação.

Example:

notes

string

Observações.

Example:

Observação

Auth

Bearer

Headers

Body

{ "name": "Construtora Exemplo", "state_id": 24, "notes": "Observa\u00e7\u00e3o" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/buildings/constructors" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Construtora Exemplo\",
    \"state_id\": 24,
    \"notes\": \"Observação\"
}"

Obter

GET

https://api.apresenta.me/buildings/constructors/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da construtora.

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name

include[state]

string

Retorna os dados do Estado da construtora.

Example:

id,name,abbreviation

include[buildings]

string

Retorna os dados dos imóveis da construtora.

Example:

id,reference,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/constructors/11?sort=id&fields=id%2Cname&include%5Bstate%5D=id%2Cname%2Cabbreviation&include%5Bbuildings%5D=id%2Creference%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/buildings/constructors/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da construtora

Example:

Body Parameters

name

string

Nome da construtora.

Example:

Construtora Exemplo 2

state_id

integer

estado de atuação.

Example:

notes

string

Observações.

Example:

Observação

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "Construtora Exemplo 2", "state_id": 24, "notes": "Observa\u00e7\u00e3o" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/buildings/constructors/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Construtora Exemplo 2\",
    \"state_id\": 24,
    \"notes\": \"Observação\"
}"

Excluir

DELETE

https://api.apresenta.me/buildings/constructors/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da construtora.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/buildings/constructors/15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Equipes de Usuários

Pesquisar

GET

https://api.apresenta.me/users/teams

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name

filter[id]

integer

Códigio da equipe de usuário.

Example:

filter[name]

string

Nome da equipa de usuário.

Example:

Equipe X

filter[business_id]

integer

Código da empresa.

Example:

filter[manager_id]

integer

Código do gerente da equipe.

Example:

filter[notes]

string

Observações da equipe.

Example:

Equipe para ...

include[manager]

string

Retorna os dados do gerente da equipe.

Example:

id,name

include[users]

string

Retorna os usuários integrantes da equipe.

Example:

id,name,email

include[business]

string

Retorna os dados da empresa relacionada à equipe.

Example:

id,name

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/users/teams?sort=id&fields=id%2Cname&filter%5Bid%5D=1&filter%5Bname%5D=Equipe+X&filter%5Bbusiness_id%5D=1&filter%5Bmanager_id%5D=1&filter%5Bnotes%5D=Equipe+para+...&include%5Bmanager%5D=id%2Cname&include%5Busers%5D=id%2Cname%2Cemail&include%5Bbusiness%5D=id%2Cname" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/users/teams

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Nome da equipe.

Example:

Vendas

manager_id

integer

required

ID do gerente da equipe, deve ser um ID de um usuário.

Example:

1010

business_id

integer

required

ID da empresa financeira que o grupo pertence.

Example:

1058

notes

string

Observação para a equipe.

Example:

temporibus

Auth

Bearer

Headers

Body

{ "name": "Vendas", "manager_id": 1010, "business_id": 1058, "notes": "temporibus" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/users/teams" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Vendas\",
    \"manager_id\": 1010,
    \"business_id\": 1058,
    \"notes\": \"temporibus\"
}"

Obter

GET

https://api.apresenta.me/users/teams/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da equipe

Example:

1096

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name

include[manager]

string

Retorna os dados do gerente da equipe.

Example:

id,name

include[users]

string

Retorna os usuários integrantes da equipe.

Example:

id,name,email

include[business]

string

Retorna os dados da empresa relacionada à equipe.

Example:

id,name

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/users/teams/1096?sort=id&fields=id%2Cname&include%5Bmanager%5D=id%2Cname&include%5Busers%5D=id%2Cname%2Cemail&include%5Bbusiness%5D=id%2Cname" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/users/teams/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id da equipe

Example:

1096

Body Parameters

name

string

Nome da equipe.

Example:

Vendas

manager_id

integer

ID do gerente da equipe, deve ser um ID de um usuário.

Example:

1010

business_id

integer

ID da empresa financeira que o grupo pertence.

Example:

1058

notes

string

Observação para a equipe.

Example:

voluptatem

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "Vendas", "manager_id": 1010, "business_id": 1058, "notes": "voluptatem" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/users/teams/1096" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Vendas\",
    \"manager_id\": 1010,
    \"business_id\": 1058,
    \"notes\": \"voluptatem\"
}"

Excluir

DELETE

https://api.apresenta.me/users/teams/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da Equipe.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/users/teams/8" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Eventos

Pesquisar

GET

https://api.apresenta.me/events

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id, description

filter[id]

integer

ID do Evento

Example:

filter[father_id]

integer

ID do Evento Pai

Example:

filter[recurrence_id]

integer

ID da Recorrência

Example:

filter[calendar_id]

integer

ID do Calendário

Example:

filter[title]

string

Título do Evento

Example:

Reunião mensal

filter[type]

string

Tipo do Evento. Valores permitidos:

task: Tarefa
reminder: Lembrete
meet: Reunião
visit: Visita
whatsapp: WhatsApp
email: Email
call: Ligação
inspect: Vistoria
maintenance: Manutenção
billing: Cobrança

Example:

task

filter[status]

string

Status do Evento Valores permitidos:

cancelled: Cancelado
concluded: Concluído
scheduled: Agendado
recurrent: Recorrente
late: Atrasado
five_days_late: +5 dias de atraso
thirty_days_late: +1 mês atrasado

Example:

scheduled

filter[guest][]

integer[]

IDs dos Convidados

Example:

filter[guest_group][]

integer[]

IDs dos Grupos de Convidados

Example:

filter[guest_access]

string

Tipo de acesso dos convidados Valores permitidos:

full: Acesso total
invite: Editar convidados
view: Visualizar

Example:

full

filter[tag][]

integer[]

IDs das Tags

Example:

filter[initial_date]

string

date Data inicial do Evento

Example:

2025-06-10

filter[final_date]

string

date Data final do Evento

Example:

2025-06-11

filter[time_zone]

string

Fuso horário Valores permitidos:

America/Sao_Paulo: Horário de Brasília -3:00
America/Noronha: Noronha -2:00
America/Manaus: Manaus -4:00
America/Rio_Branco: Rio Branco -5:00
Atlantic/Azores: Açores -1:00
America/Costa_Rica: Costa Rica -6:00
America/Tijuana: Tijuana -7:00
America/Sitka: Sitka -8:00
Pacific/Gambier: Gambier -9:00
Pacific/Honolulu: Honolulu -10:00
Pacific/Midway: Midway -11:00

Example:

America/Sao_Paulo

filter[created_by]

integer

ID do Criador

Example:

filter[building_id]

integer

ID do Imóvel

Example:

filter[deal_id]

integer

ID do Negócio

Example:

filter[contract_id]

integer

ID do contrato

Example:

123456

filter[person_id]

integer

ID da Pessoa

Example:

filter[invite_person]

boolean

Se convidou pessoa

Example:

filter[endless]

boolean

Evento sem fim

Example:

filter[all_day]

boolean

Evento o dia todo

Example:

filter[description]

string

Descrição do Evento

Example:

Discussão de metas

filter[address]

string

Endereço do Evento

Example:

Av. Paulista, 1000

filter[reminder][]

string[]

Lembretes do Evento Valores permitidos:

START: Ao Iniciar ao Evento
5_MIN: 5 minutos antes de começar
15_MIN: 5 minutos antes de começar
30_MIN: 0 minutos antes de começar
1_HOUR: 1 hora antes de começar
2_HOUR: 2 horas antes de começar
6_HOUR: 6 horas antes de começar
1_DAY: 1 dia antes de começar
2_DAY: 2 dias antes de começar
5_DAY: 5 dias antes de começar
1_WEEK: 1 semana antes de começar
2_WEEK: 2 semanas antes de começar
1_MONTH: 1 mês antes de começar

Example:

START

filter[private]

boolean

Evento privado

Example:

filter[recurrency]

string

Recorrência do Evento Valores permitidos:

daily: Diária
weekly: Semanal
monthly: Mensal
yearly: Anual

Example:

weekly

filter[accessible]

integer

Filtra eventos acessíveis pelo usuário informado

Example:

filter[descendant][]

integer[]

Filtra eventos descendentes do ID informado

Example:

filter[guestsIn][]

integer[]

Filtra eventos onde o usuário é convidado

Example:

filter[responsibleIn][]

integer[]

Filtra eventos onde o usuário é responsável

Example:

filter[userIn][]

integer[]

Filtra eventos pelo(s) usuário(s) convidado(s)

Example:

filter[responsibleGroupIn][]

integer[]

Filtra eventos pelo(s) grupo(s) responsável(is)

Example:

filter[creatorIn][]

integer[]

Filtra eventos pelo(s) criador(es)

Example:

filter[calendarIn][]

integer[]

Filtra eventos pelo(s) calendário(s)

Example:

filter[createdBetween][]

string[]

Filtra eventos pela data de criação (intervalo)

Example:

2025-06-01

filter[typeIn][]

string[]

Filtra eventos pelos tipos

filter[dateMinMax][]

string[]

Filtra eventos pela data inicial (intervalo)

Example:

2024-01-01

filter[isLate]

boolean

Filtra eventos atrasados

Example:

filter[isNotRecurrence]

boolean

Filtra eventos que não são recorrências

Example:

filter[isCancelled]

boolean

Filtra eventos cancelados

Example:

filter[notCancelled]

boolean

Filtra eventos não cancelados

Example:

filter[scheduledBetween][]

string[]

Filtra eventos agendados entre datas

Example:

2025-06-01

filter[active]

boolean

Filtra eventos ativos

Example:

filter[statusIn][]

string[]

Filtra eventos pelos status

Example:

scheduled

filter[statusNotIn][]

string[]

Filtra eventos excluindo status

Example:

cancelled

filter[recurrencyIn][]

string[]

Filtra eventos pela recorrência

Example:

weekly

filter[hasReminder]

boolean

Filtra eventos com lembrete

Example:

filter[hasAnyReminder]

boolean

Filtra eventos com qualquer lembrete

Example:

filter[buildingIn][]

integer[]

Filtra eventos pelo(s) imóvel(is)

Example:

filter[dealIn][]

integer[]

Filtra eventos pelo(s) negócio(s)

Example:

filter[personIn][]

integer[]

Filtra eventos pela(s) pessoa(s)

Example:

filter[googleId]

string

Filtra eventos pelo Google ID

Example:

abc123

filter[occurrenceBetween][]

string[]

Filtra eventos por ocorrência entre datas

Example:

2025-06-01

filter[yearBetween][]

string[]

Filtra eventos recorrentes anuais entre datas

Example:

2025-01-01

filter[monthBetween][]

string[]

Filtra eventos recorrentes mensais entre datas

Example:

2025-06-01

filter[weekBetween][]

string[]

Filtra eventos recorrentes semanais entre datas

Example:

2025-06-01

filter[dayBetween][]

string[]

Filtra eventos recorrentes diários entre datas

Example:

2025-06-01

filter[nonRecurring]

boolean

Filtra eventos não recorrentes

Example:

include[guests]

string

Incluir dados dos Convidados

Example:

id,name,email

include[guestGroups]

string

Incluir dados dos Grupos de Convidados

Example:

id,name,users

include[tags]

string

Incluir dados das Tags

Example:

id,name

include[creator]

string

Incluir dados do Criador

Example:

id,name,email

include[calendar]

string

Incluir dados do Calendário

Example:

id,title

include[person]

string

Incluir dados da Pessoa

Example:

id,name

include[building]

string

Incluir dados do Imóvel

Example:

id,title

include[deal]

string

Incluir dados do Negócio

Example:

id,title

include[parent]

string

Incluir dados do Evento Pai

Example:

id,title

include[childs]

string

Incluir dados dos Eventos Filhos

Example:

id,title

include[arisingFrom]

string

Incluir dados do Evento de Origem

Example:

id,title

include[recurrences]

string

Incluir dados das Recorrências

Example:

id,title

include[cancelled]

string

Incluir dados das Recorrências Canceladas

Example:

id,title

include[files]

string

Incluir arquivos anexados

Example:

id,file_name,url

include[lastFeedback]

string

Incluir último feedback

Example:

id,date,history_type_id

include[contract]

string

Incluir dados do Contrato

Example:

id,type

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/events?sort=id&fields=id%2C+description&filter%5Bid%5D=2&filter%5Bfather_id%5D=10&filter%5Brecurrence_id%5D=5&filter%5Bcalendar_id%5D=3&filter%5Btitle%5D=Reuni%C3%A3o+mensal&filter%5Btype%5D=task&filter%5Bstatus%5D=scheduled&filter%5Bguest%5D%5B%5D=1&filter%5Bguest_group%5D%5B%5D=2&filter%5Bguest_access%5D=full&filter%5Btag%5D%5B%5D=1&filter%5Binitial_date%5D=2025-06-10&filter%5Bfinal_date%5D=2025-06-11&filter%5Btime_zone%5D=America%2FSao_Paulo&filter%5Bcreated_by%5D=7&filter%5Bbuilding_id%5D=12&filter%5Bdeal_id%5D=8&filter%5Bcontract_id%5D=123456&filter%5Bperson_id%5D=5&filter%5Binvite_person%5D=1&filter%5Bendless%5D=1&filter%5Ball_day%5D=1&filter%5Bdescription%5D=Discuss%C3%A3o+de+metas&filter%5Baddress%5D=Av.+Paulista%2C+1000&filter%5Breminder%5D%5B%5D=START&filter%5Bprivate%5D=1&filter%5Brecurrency%5D=weekly&filter%5Baccessible%5D=7&filter%5Bdescendant%5D%5B%5D=1&filter%5BguestsIn%5D%5B%5D=1&filter%5BresponsibleIn%5D%5B%5D=1&filter%5BuserIn%5D%5B%5D=1&filter%5BresponsibleGroupIn%5D%5B%5D=1&filter%5BcreatorIn%5D%5B%5D=7&filter%5BcalendarIn%5D%5B%5D=3&filter%5BcreatedBetween%5D%5B%5D=2025-06-01&filter%5BtypeIn%5D%5B%5D=&filter%5BdateMinMax%5D%5B%5D=2024-01-01&filter%5BisLate%5D=1&filter%5BisNotRecurrence%5D=1&filter%5BisCancelled%5D=1&filter%5BnotCancelled%5D=1&filter%5BscheduledBetween%5D%5B%5D=2025-06-01&filter%5Bactive%5D=1&filter%5BstatusIn%5D%5B%5D=scheduled&filter%5BstatusNotIn%5D%5B%5D=cancelled&filter%5BrecurrencyIn%5D%5B%5D=weekly&filter%5BhasReminder%5D=1&filter%5BhasAnyReminder%5D=1&filter%5BbuildingIn%5D%5B%5D=1&filter%5BdealIn%5D%5B%5D=8&filter%5BpersonIn%5D%5B%5D=5&filter%5BgoogleId%5D=abc123&filter%5BoccurrenceBetween%5D%5B%5D=2025-06-01&filter%5ByearBetween%5D%5B%5D=2025-01-01&filter%5BmonthBetween%5D%5B%5D=2025-06-01&filter%5BweekBetween%5D%5B%5D=2025-06-01&filter%5BdayBetween%5D%5B%5D=2025-06-01&filter%5BnonRecurring%5D=1&include%5Bguests%5D=id%2Cname%2Cemail&include%5BguestGroups%5D=id%2Cname%2Cusers&include%5Btags%5D=id%2Cname&include%5Bcreator%5D=id%2Cname%2Cemail&include%5Bcalendar%5D=id%2Ctitle&include%5Bperson%5D=id%2Cname&include%5Bbuilding%5D=id%2Ctitle&include%5Bdeal%5D=id%2Ctitle&include%5Bparent%5D=id%2Ctitle&include%5Bchilds%5D=id%2Ctitle&include%5BarisingFrom%5D=id%2Ctitle&include%5Brecurrences%5D=id%2Ctitle&include%5Bcancelled%5D=id%2Ctitle&include%5Bfiles%5D=id%2Cfile_name%2Curl&include%5BlastFeedback%5D=id%2Cdate%2Chistory_type_id&include%5Bcontract%5D=id%2Ctype" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.apresenta.me/events"
);

const params = {
    "sort": "id",
    "fields": "id, description",
    "filter[id]": "2",
    "filter[father_id]": "10",
    "filter[recurrence_id]": "5",
    "filter[calendar_id]": "3",
    "filter[title]": "Reunião mensal",
    "filter[type]": "task",
    "filter[status]": "scheduled",
    "filter[guest][]": "1",
    "filter[guest_group][]": "2",
    "filter[guest_access]": "full",
    "filter[tag][]": "1",
    "filter[initial_date]": "2025-06-10",
    "filter[final_date]": "2025-06-11",
    "filter[time_zone]": "America/Sao_Paulo",
    "filter[created_by]": "7",
    "filter[building_id]": "12",
    "filter[deal_id]": "8",
    "filter[contract_id]": "123456",
    "filter[person_id]": "5",
    "filter[invite_person]": "1",
    "filter[endless]": "1",
    "filter[all_day]": "1",
    "filter[description]": "Discussão de metas",
    "filter[address]": "Av. Paulista, 1000",
    "filter[reminder][]": "START",
    "filter[private]": "1",
    "filter[recurrency]": "weekly",
    "filter[accessible]": "7",
    "filter[descendant][]": "1",
    "filter[guestsIn][]": "1",
    "filter[responsibleIn][]": "1",
    "filter[userIn][]": "1",
    "filter[responsibleGroupIn][]": "1",
    "filter[creatorIn][]": "7",
    "filter[calendarIn][]": "3",
    "filter[createdBetween][]": "2025-06-01",
    "filter[typeIn][]": "",
    "filter[dateMinMax][]": "2024-01-01",
    "filter[isLate]": "1",
    "filter[isNotRecurrence]": "1",
    "filter[isCancelled]": "1",
    "filter[notCancelled]": "1",
    "filter[scheduledBetween][]": "2025-06-01",
    "filter[active]": "1",
    "filter[statusIn][]": "scheduled",
    "filter[statusNotIn][]": "cancelled",
    "filter[recurrencyIn][]": "weekly",
    "filter[hasReminder]": "1",
    "filter[hasAnyReminder]": "1",
    "filter[buildingIn][]": "1",
    "filter[dealIn][]": "8",
    "filter[personIn][]": "5",
    "filter[googleId]": "abc123",
    "filter[occurrenceBetween][]": "2025-06-01",
    "filter[yearBetween][]": "2025-01-01",
    "filter[monthBetween][]": "2025-06-01",
    "filter[weekBetween][]": "2025-06-01",
    "filter[dayBetween][]": "2025-06-01",
    "filter[nonRecurring]": "1",
    "include[guests]": "id,name,email",
    "include[guestGroups]": "id,name,users",
    "include[tags]": "id,name",
    "include[creator]": "id,name,email",
    "include[calendar]": "id,title",
    "include[person]": "id,name",
    "include[building]": "id,title",
    "include[deal]": "id,title",
    "include[parent]": "id,title",
    "include[childs]": "id,title",
    "include[arisingFrom]": "id,title",
    "include[recurrences]": "id,title",
    "include[cancelled]": "id,title",
    "include[files]": "id,file_name,url",
    "include[lastFeedback]": "id,date,history_type_id",
    "include[contract]": "id,type",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/events';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'sort' => 'id',
            'fields' => 'id, description',
            'filter[id]' => '2',
            'filter[father_id]' => '10',
            'filter[recurrence_id]' => '5',
            'filter[calendar_id]' => '3',
            'filter[title]' => 'Reunião mensal',
            'filter[type]' => 'task',
            'filter[status]' => 'scheduled',
            'filter[guest][]' => '1',
            'filter[guest_group][]' => '2',
            'filter[guest_access]' => 'full',
            'filter[tag][]' => '1',
            'filter[initial_date]' => '2025-06-10',
            'filter[final_date]' => '2025-06-11',
            'filter[time_zone]' => 'America/Sao_Paulo',
            'filter[created_by]' => '7',
            'filter[building_id]' => '12',
            'filter[deal_id]' => '8',
            'filter[contract_id]' => '123456',
            'filter[person_id]' => '5',
            'filter[invite_person]' => '1',
            'filter[endless]' => '1',
            'filter[all_day]' => '1',
            'filter[description]' => 'Discussão de metas',
            'filter[address]' => 'Av. Paulista, 1000',
            'filter[reminder][]' => 'START',
            'filter[private]' => '1',
            'filter[recurrency]' => 'weekly',
            'filter[accessible]' => '7',
            'filter[descendant][]' => '1',
            'filter[guestsIn][]' => '1',
            'filter[responsibleIn][]' => '1',
            'filter[userIn][]' => '1',
            'filter[responsibleGroupIn][]' => '1',
            'filter[creatorIn][]' => '7',
            'filter[calendarIn][]' => '3',
            'filter[createdBetween][]' => '2025-06-01',
            'filter[typeIn][]' => '',
            'filter[dateMinMax][]' => '2024-01-01',
            'filter[isLate]' => '1',
            'filter[isNotRecurrence]' => '1',
            'filter[isCancelled]' => '1',
            'filter[notCancelled]' => '1',
            'filter[scheduledBetween][]' => '2025-06-01',
            'filter[active]' => '1',
            'filter[statusIn][]' => 'scheduled',
            'filter[statusNotIn][]' => 'cancelled',
            'filter[recurrencyIn][]' => 'weekly',
            'filter[hasReminder]' => '1',
            'filter[hasAnyReminder]' => '1',
            'filter[buildingIn][]' => '1',
            'filter[dealIn][]' => '8',
            'filter[personIn][]' => '5',
            'filter[googleId]' => 'abc123',
            'filter[occurrenceBetween][]' => '2025-06-01',
            'filter[yearBetween][]' => '2025-01-01',
            'filter[monthBetween][]' => '2025-06-01',
            'filter[weekBetween][]' => '2025-06-01',
            'filter[dayBetween][]' => '2025-06-01',
            'filter[nonRecurring]' => '1',
            'include[guests]' => 'id,name,email',
            'include[guestGroups]' => 'id,name,users',
            'include[tags]' => 'id,name',
            'include[creator]' => 'id,name,email',
            'include[calendar]' => 'id,title',
            'include[person]' => 'id,name',
            'include[building]' => 'id,title',
            'include[deal]' => 'id,title',
            'include[parent]' => 'id,title',
            'include[childs]' => 'id,title',
            'include[arisingFrom]' => 'id,title',
            'include[recurrences]' => 'id,title',
            'include[cancelled]' => 'id,title',
            'include[files]' => 'id,file_name,url',
            'include[lastFeedback]' => 'id,date,history_type_id',
            'include[contract]' => 'id,type',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.apresenta.me/events'
params = {
  'sort': 'id',
  'fields': 'id, description',
  'filter[id]': '2',
  'filter[father_id]': '10',
  'filter[recurrence_id]': '5',
  'filter[calendar_id]': '3',
  'filter[title]': 'Reunião mensal',
  'filter[type]': 'task',
  'filter[status]': 'scheduled',
  'filter[guest][]': '1',
  'filter[guest_group][]': '2',
  'filter[guest_access]': 'full',
  'filter[tag][]': '1',
  'filter[initial_date]': '2025-06-10',
  'filter[final_date]': '2025-06-11',
  'filter[time_zone]': 'America/Sao_Paulo',
  'filter[created_by]': '7',
  'filter[building_id]': '12',
  'filter[deal_id]': '8',
  'filter[contract_id]': '123456',
  'filter[person_id]': '5',
  'filter[invite_person]': '1',
  'filter[endless]': '1',
  'filter[all_day]': '1',
  'filter[description]': 'Discussão de metas',
  'filter[address]': 'Av. Paulista, 1000',
  'filter[reminder][]': 'START',
  'filter[private]': '1',
  'filter[recurrency]': 'weekly',
  'filter[accessible]': '7',
  'filter[descendant][]': '1',
  'filter[guestsIn][]': '1',
  'filter[responsibleIn][]': '1',
  'filter[userIn][]': '1',
  'filter[responsibleGroupIn][]': '1',
  'filter[creatorIn][]': '7',
  'filter[calendarIn][]': '3',
  'filter[createdBetween][]': '2025-06-01',
  'filter[typeIn][]': '',
  'filter[dateMinMax][]': '2024-01-01',
  'filter[isLate]': '1',
  'filter[isNotRecurrence]': '1',
  'filter[isCancelled]': '1',
  'filter[notCancelled]': '1',
  'filter[scheduledBetween][]': '2025-06-01',
  'filter[active]': '1',
  'filter[statusIn][]': 'scheduled',
  'filter[statusNotIn][]': 'cancelled',
  'filter[recurrencyIn][]': 'weekly',
  'filter[hasReminder]': '1',
  'filter[hasAnyReminder]': '1',
  'filter[buildingIn][]': '1',
  'filter[dealIn][]': '8',
  'filter[personIn][]': '5',
  'filter[googleId]': 'abc123',
  'filter[occurrenceBetween][]': '2025-06-01',
  'filter[yearBetween][]': '2025-01-01',
  'filter[monthBetween][]': '2025-06-01',
  'filter[weekBetween][]': '2025-06-01',
  'filter[dayBetween][]': '2025-06-01',
  'filter[nonRecurring]': '1',
  'include[guests]': 'id,name,email',
  'include[guestGroups]': 'id,name,users',
  'include[tags]': 'id,name',
  'include[creator]': 'id,name,email',
  'include[calendar]': 'id,title',
  'include[person]': 'id,name',
  'include[building]': 'id,title',
  'include[deal]': 'id,title',
  'include[parent]': 'id,title',
  'include[childs]': 'id,title',
  'include[arisingFrom]': 'id,title',
  'include[recurrences]': 'id,title',
  'include[cancelled]': 'id,title',
  'include[files]': 'id,file_name,url',
  'include[lastFeedback]': 'id,date,history_type_id',
  'include[contract]': 'id,type',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/events

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

filter[calendar_id]

integer

required

ID do Calendário

Example:

filter[title]

string

required

Título do Evento

Example:

Reunião mensal

filter[guest][]

integer[]

required

IDs dos Convidados

Example:

filter[guest_group][]

integer[]

required

IDs dos Grupos de Convidados

Example:

filter[guest_access]

string

required

Tipo de acesso dos convidados Valores permitidos:

full: Acesso total
invite: Editar convidados
view: Visualizar

Example:

full

filter[type]

string

required

Tipo do Evento. Valores permitidos:

task: Tarefa
reminder: Lembrete
meet: Reunião
visit: Visita
whatsapp: WhatsApp
email: Email
call: Ligação

Example:

task

filter[status]

string

required

Status do Evento Valores permitidos:

cancelled: Cancelado
concluded: Concluído
scheduled: Agendado
recurrent: Recorrente
late: Atrasado
five_days_late: +5 dias de atraso
thirty_days_late: +1 mês atrasado

Example:

scheduled

filter[initial_date]

date

required

Data inicial do Evento

Example:

2025-06-10

filter[father_id]

integer

ID do Evento Pai

Example:

filter[recurrence_id]

integer

ID da Recorrência

Example:

filter[tag][]

integer[]

IDs das Tags

Example:

filter[final_date]

date

Data final do Evento

Example:

2025-06-11

filter[time_zone]

string

Fuso horário Valores permitidos:

America/Sao_Paulo: Horário de Brasília -3:00
America/Noronha: Noronha -2:00
America/Manaus: Manaus -4:00
America/Rio_Branco: Rio Branco -5:00
Atlantic/Azores: Açores -1:00
America/Costa_Rica: Costa Rica -6:00
America/Tijuana: Tijuana -7:00
America/Sitka: Sitka -8:00
Pacific/Gambier: Gambier -9:00
Pacific/Honolulu: Honolulu -10:00
Pacific/Midway: Midway -11:00

Example:

America/Sao_Paulo

filter[created_by]

integer

ID do Criador

Example:

filter[building_id]

integer

ID do Imóvel

Example:

filter[deal_id]

integer

ID do Negócio

Example:

filter[contract_id]

integer

ID do contrato

Example:

123456

filter[person_id]

integer

ID da Pessoa

Example:

filter[invite_person]

boolean

Se convidou pessoa

Example:

filter[endless]

boolean

Evento sem fim

filter[all_day]

boolean

Evento o dia todo

Example:

filter[description]

string

Descrição do Evento

Example:

Discussão de metas

filter[address]

string

Endereço do Evento

Example:

Av. Paulista, 1000

filter[reminder][]

string[]

Lembretes do Evento Valores permitidos: = START: Ao Iniciar ao Evento = 5_MIN: 5 minutos antes de começar = 15_MIN: 5 minutos antes de começar = 30_MIN: 0 minutos antes de começar = 1_HOUR: 1 hora antes de começar = 2_HOUR: 2 horas antes de começar = 6_HOUR: 6 horas antes de começar = 1_DAY: 1 dia antes de começar = 2_DAY: 2 dias antes de começar = 5_DAY: 5 dias antes de começar = 1_WEEK: 1 semana antes de começar = 2_WEEK: 2 semanas antes de começar = 1_MONTH: 1 mês antes de começar

Example:

START

filter[private]

boolean

Evento privado

filter[recurrency]

string

Recorrência do Evento Valores permitidos:

daily: Diária
weekly: Semanal
monthly: Mensal
yearly: Anual

Example:

weekly

Auth

Bearer

Headers

Body

{ "filter[calendar_id]": 3, "filter[title]": "Reuni\u00e3o mensal", "filter[guest][]": 1, "filter[guest_group][]": 2, "filter[guest_access]": "full", "filter[type]": "task", "filter[status]": "scheduled", "filter[initial_date]": "2025-06-10", "filter[father_id]": 10, "filter[recurrence_id]": 5, "filter[tag][]": 1, "filter[final_date]": "2025-06-11", "filter[time_zone]": "America\/Sao_Paulo", "filter[created_by]": 7, "filter[building_id]": 12, "filter[deal_id]": 8, "filter[contract_id]": 123456, "filter[person_id]": 5, "filter[invite_person]": true, "filter[endless]": false, "filter[all_day]": true, "filter[description]": "Discuss\u00e3o de metas", "filter[address]": "Av. Paulista, 1000", "filter[reminder][]": "START", "filter[private]": false, "filter[recurrency]": "weekly" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/events" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter[calendar_id]\": 3,
    \"filter[title]\": \"Reunião mensal\",
    \"filter[guest][]\": 1,
    \"filter[guest_group][]\": 2,
    \"filter[guest_access]\": \"full\",
    \"filter[type]\": \"task\",
    \"filter[status]\": \"scheduled\",
    \"filter[initial_date]\": \"2025-06-10\",
    \"filter[father_id]\": 10,
    \"filter[recurrence_id]\": 5,
    \"filter[tag][]\": 1,
    \"filter[final_date]\": \"2025-06-11\",
    \"filter[time_zone]\": \"America\\/Sao_Paulo\",
    \"filter[created_by]\": 7,
    \"filter[building_id]\": 12,
    \"filter[deal_id]\": 8,
    \"filter[contract_id]\": 123456,
    \"filter[person_id]\": 5,
    \"filter[invite_person]\": true,
    \"filter[endless]\": false,
    \"filter[all_day]\": true,
    \"filter[description]\": \"Discussão de metas\",
    \"filter[address]\": \"Av. Paulista, 1000\",
    \"filter[reminder][]\": \"START\",
    \"filter[private]\": false,
    \"filter[recurrency]\": \"weekly\"
}"

Obter

GET

https://api.apresenta.me/events/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do ticket

Example:

Query Parameters

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id, description

include[guests]

string

Incluir dados dos Convidados

Example:

id,name,email

include[guestGroups]

string

Incluir dados dos Grupos de Convidados

Example:

id,name,users

include[tags]

string

Incluir dados das Tags

Example:

id,name

include[creator]

string

Incluir dados do Criador

Example:

id,name,email

include[calendar]

string

Incluir dados do Calendário

Example:

id,title

include[person]

string

Incluir dados da Pessoa

Example:

id,name

include[building]

string

Incluir dados do Imóvel

Example:

id,title

include[deal]

string

Incluir dados do Negócio

Example:

id,title

include[parent]

string

Incluir dados do Evento Pai

Example:

id,title

include[childs]

string

Incluir dados dos Eventos Filhos

Example:

id,title

include[arisingFrom]

string

Incluir dados do Evento de Origem

Example:

id,title

include[recurrences]

string

Incluir dados das Recorrências

Example:

id,title

include[cancelled]

string

Incluir dados das Recorrências Canceladas

Example:

id,title

include[files]

string

Incluir arquivos anexados

Example:

id,file_name,url

include[lastFeedback]

string

Incluir último feedback

Example:

id,date,history_type_id

include[contract]

string

Incluir dados do Contrato

Example:

id,type

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/events/16?fields=id%2C+description&include%5Bguests%5D=id%2Cname%2Cemail&include%5BguestGroups%5D=id%2Cname%2Cusers&include%5Btags%5D=id%2Cname&include%5Bcreator%5D=id%2Cname%2Cemail&include%5Bcalendar%5D=id%2Ctitle&include%5Bperson%5D=id%2Cname&include%5Bbuilding%5D=id%2Ctitle&include%5Bdeal%5D=id%2Ctitle&include%5Bparent%5D=id%2Ctitle&include%5Bchilds%5D=id%2Ctitle&include%5BarisingFrom%5D=id%2Ctitle&include%5Brecurrences%5D=id%2Ctitle&include%5Bcancelled%5D=id%2Ctitle&include%5Bfiles%5D=id%2Cfile_name%2Curl&include%5BlastFeedback%5D=id%2Cdate%2Chistory_type_id&include%5Bcontract%5D=id%2Ctype" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/events/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Evento

Example:

Body Parameters

filter[title]

string

Título do Evento

Example:

Reunião mensal

filter[guest][]

integer[]

IDs dos Convidados

Example:

filter[guest_group][]

integer[]

IDs dos Grupos de Convidados

Example:

filter[guest_access]

string

Tipo de acesso dos convidados Valores permitidos:

full: Acesso total
invite: Editar convidados
view: Visualizar

Example:

full

filter[type]

string

Tipo do Evento. Valores permitidos:

task: Tarefa
reminder: Lembrete
meet: Reunião
visit: Visita
whatsapp: WhatsApp
email: Email
call: Ligação

Example:

task

filter[status]

string

Status do Evento Valores permitidos:

cancelled: Cancelado
concluded: Concluído
scheduled: Agendado
recurrent: Recorrente
late: Atrasado
five_days_late: +5 dias de atraso
thirty_days_late: +1 mês atrasado

Example:

scheduled

filter[initial_date]

date

Data inicial do Evento

Example:

2025-06-10

filter[father_id]

integer

ID do Evento Pai

Example:

filter[recurrence_id]

integer

ID da Recorrência

Example:

filter[tag][]

integer[]

IDs das Tags

Example:

filter[final_date]

date

Data final do Evento

Example:

2025-06-11

filter[time_zone]

string

Fuso horário Valores permitidos:

America/Sao_Paulo: Horário de Brasília -3:00
America/Noronha: Noronha -2:00
America/Manaus: Manaus -4:00
America/Rio_Branco: Rio Branco -5:00
Atlantic/Azores: Açores -1:00
America/Costa_Rica: Costa Rica -6:00
America/Tijuana: Tijuana -7:00
America/Sitka: Sitka -8:00
Pacific/Gambier: Gambier -9:00
Pacific/Honolulu: Honolulu -10:00
Pacific/Midway: Midway -11:00

Example:

America/Sao_Paulo

filter[building_id]

integer

ID do Imóvel

Example:

filter[deal_id]

integer

ID do Negócio

Example:

filter[contract_id]

integer

ID do contrato

Example:

123456

filter[person_id]

integer

ID da Pessoa

Example:

filter[invite_person]

boolean

Se convidou pessoa

Example:

filter[endless]

boolean

Evento sem fim

filter[all_day]

boolean

Evento o dia todo

Example:

filter[description]

string

Descrição do Evento

Example:

Discussão de metas

filter[address]

string

Endereço do Evento

Example:

Av. Paulista, 1000

filter[reminder][]

string[]

Example:

START

filter[private]

boolean

Evento privado

filter[recurrency]

string

Recorrência do Evento Valores permitidos:

daily: Diária
weekly: Semanal
monthly: Mensal
yearly: Anual

Example:

weekly

Auth

Bearer

Headers

URL Parameters

Body

{ "filter[title]": "Reuni\u00e3o mensal", "filter[guest][]": 1, "filter[guest_group][]": 2, "filter[guest_access]": "full", "filter[type]": "task", "filter[status]": "scheduled", "filter[initial_date]": "2025-06-10", "filter[father_id]": 10, "filter[recurrence_id]": 5, "filter[tag][]": 1, "filter[final_date]": "2025-06-11", "filter[time_zone]": "America\/Sao_Paulo", "filter[building_id]": 12, "filter[deal_id]": 8, "filter[contract_id]": 123456, "filter[person_id]": 5, "filter[invite_person]": true, "filter[endless]": false, "filter[all_day]": true, "filter[description]": "Discuss\u00e3o de metas", "filter[address]": "Av. Paulista, 1000", "filter[reminder][]": "START", "filter[private]": false, "filter[recurrency]": "weekly" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/events/19" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter[title]\": \"Reunião mensal\",
    \"filter[guest][]\": 1,
    \"filter[guest_group][]\": 2,
    \"filter[guest_access]\": \"full\",
    \"filter[type]\": \"task\",
    \"filter[status]\": \"scheduled\",
    \"filter[initial_date]\": \"2025-06-10\",
    \"filter[father_id]\": 10,
    \"filter[recurrence_id]\": 5,
    \"filter[tag][]\": 1,
    \"filter[final_date]\": \"2025-06-11\",
    \"filter[time_zone]\": \"America\\/Sao_Paulo\",
    \"filter[building_id]\": 12,
    \"filter[deal_id]\": 8,
    \"filter[contract_id]\": 123456,
    \"filter[person_id]\": 5,
    \"filter[invite_person]\": true,
    \"filter[endless]\": false,
    \"filter[all_day]\": true,
    \"filter[description]\": \"Discussão de metas\",
    \"filter[address]\": \"Av. Paulista, 1000\",
    \"filter[reminder][]\": \"START\",
    \"filter[private]\": false,
    \"filter[recurrency]\": \"weekly\"
}"

Excluir

DELETE

https://api.apresenta.me/events/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Evento

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/events/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Financeiro

Faturas

Gerar link do Recibo de Recebimento

GET

https://api.apresenta.me/invoices/{invoice_id}/receiptLink

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

invoice_id

integer

required

ID da Fatura

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/invoices/16/receiptLink" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Pesquisar

GET

https://api.apresenta.me/invoices

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,type,total

filter[id]

string

ID da fatura.

Example:

filter[id2]

string

ID da fatura por empresa.

Example:

filter[type]

string

Tipo da fatura. Valores permitidos:

single: Avulsa
contract: Contrato

Example:

single

filter[payer_id]

integer

ID do pagador.

Example:

filter[contract_id]

integer

ID do contrato.

Example:

filter[business_id]

integer

ID da empresa.

Example:

filter[account_id]

integer

ID da conta bancária.

Example:

filter[billing_id]

integer

ID do método de cobrança automático.

Example:

filter[billing_method]

string

Método de cobrança. Valores permitidos:

ticket: Boleto
cash: Dinheiro
deposit: Depósito
pix: PIX
ted: DOC/TED
credit: Cartão de Crédito
debit: Cartão de Débito
check: Cheque
debit_account: Débito em Conta

Example:

pix

filter[paid]

boolean

Filtra faturas pagas.

Example:

filter[paid_at]

string

date Data do pagamento.

Example:

2024-01-01

filter[credit_at]

string

date Data do crédito.

Example:

2024-01-02

filter[payment_error]

boolean

Erro no pagamento.

Example:

filter[description]

string

Descrição da fatura.

Example:

Fatura X

filter[total]

string

Valor total da fatura.

Example:

1200

filter[date]

string

date Competência.

Example:

2024-01-01

filter[due_date]

string

date Data de vencimento.

Example:

2024-01-10

filter[guaranteed_transfer]

boolean

Repasse garantido.

Example:

filter[period_initial]

string

date Data de início da fatura, aluguel.

Example:

2024-01-01

filter[period_final]

string

date Data final da fatura, aluguel.

Example:

2024-01-31

filter[tag]

string[]

Tags da fatura.

Example:

[123,456,789]

filter[ticket_registered]

boolean

Boleto registrado.

filter[ticket_date]

string

date Data do boleto.

Example:

2024-01-01 00:00:00

filter[ticket_key]

string

ID da cobrança dentro do banco integrador (Asaas).

Example:

abc123

filter[ticket_id]

integer

ID do boleto.

Example:

filter[ticket_fee]

string

Taxa do boleto.

Example:

12.0

filter[ticket_link]

string

Link do boleto.

Example:

https://api.pjbank.com.br/boletos/823a8ee8043b3a96e2df963bead9gg63e5ea16c1

filter[ticket_barcode]

string

Código de barras do boleto .

Example:

12395828200001760000010003821587100516853008

filter[ticket_info]

string

Informações do boleto.

Example:

Este boleto...

filter[ticket_digitable]

string

Linha digitável do boleto.

Example:

12390.01007 03821.587106 05168.530086 5 82820000176000

filter[ticket_without_pix]

boolean

Boleto sem pix.

filter[ticket_late_fee]

boolean

Adicionar Multa e Juros para contratos de Locação.

Example:

filter[ticket_late_fee_item_id]

integer

ID do item que será aplicado a multa.

Example:

filter[ticket_late_fee_percentage]

integer

Multa (%).

Example:

filter[ticket_late_fee_interest]

integer

Juros (%).

Example:

filter[ticket_discount]

boolean

Adicionar Desconto de Pontualidade.

Example:

filter[ticket_discount_mode]

string

Modo de desconto. Valores permitidos:

fixed: Valor Fixo
percentage: Porcentagem

Example:

percentage

filter[ticket_discount_fixed]

string

Desconto (R$).

Example:

123.20

filter[ticket_discount_percentage]

string

Desconto(%).

Example:

filter[ticket_discount_action]

string

Ação do desconto de pontualidade. Valores permitidos:

business: Reter desconto para imobiliária
owner: Repassar desconto ao proprietário

Example:

business

filter[ticket_discount_days]

integer

Quantidade de dias antes do vencimento.

Example:

filter[transfer_auto_disabled]

boolean

Desativar repasse automático.

filter[protest]

string

json Protesto.

Example:

{"status":"PENDING"}

filter[ticketIdIn][]

string[]

Filtra faturas por IDs de ticket (chave do integrador).

filter[idOldIn][]

integer[]

Filtra faturas por IDs antigos (id2).

Example:

100

filter[referenceId]

string

Filtra faturas por ID de referência.

Example:

REF-001

filter[emptyProtest]

boolean

Filtra faturas sem protesto.

Example:

filter[protestIdIn][]

integer[]

Filtra faturas por IDs de protesto.

Example:

filter[unpaid]

boolean

Filtra faturas não pagas.

Example:

filter[overdue]

boolean

Filtra faturas vencidas.

Example:

filter[early]

boolean

Filtra faturas a vencer.

Example:

filter[contractIn][]

integer[]

Filtra faturas por IDs de contrato.

Example:

filter[contractIdIn][]

integer[]

Filtra faturas por IDs de contrato (id2).

filter[buildingIn][]

integer[]

Filtra faturas por IDs de imóvel.

Example:

filter[buildingId2In][]

integer[]

Filtra faturas por IDs de imóvel (id2).

filter[dateMin]

string

Filtra faturas por data mínima.

Example:

2024-01-01

filter[dateMax]

string

Filtra faturas por data máxima.

Example:

2024-01-31

filter[dueDateMin]

string

Filtra faturas por data de vencimento mínima.

Example:

2024-01-10

filter[businessIn][]

integer[]

Filtra faturas por IDs de empresa.

Example:

filter[accountIn][]

integer[]

Filtra faturas por IDs de conta financeira.

Example:

filter[payerIn][]

integer[]

Filtra faturas por IDs de pagador.

Example:

filter[ownerIn][]

integer[]

Filtra faturas por IDs de proprietário.

Example:

filter[tenantIn][]

integer[]

Filtra faturas por IDs de inquilino.

Example:

filter[registered]

boolean

Filtra faturas registradas.

Example:

filter[registeredOrPix]

boolean

Filtra faturas registradas ou com Pix.

Example:

filter[billingMethodIn][]

string[]

Filtra faturas por métodos de cobrança.

filter[tagIn][]

integer[]

Filtra faturas por tags.

Example:

100

filter[autoTransferStatus][]

string[]

Filtra faturas por status de transferência automática.

filter[periodContains]

string

Filtra faturas cujo período contém a data especificada.

Example:

2024-01-15

filter[payerTaxIdIn][]

string[]

Filtra faturas por CPF/CNPJ do pagador.

Example:

000.000.000-00

include[items]

string

Example:

dignissimos

include[itemsPayer]

string

Example:

include[itemsAllGroupTransfer]

string

Example:

sunt

include[itemsAll]

string

Example:

quo

include[autoTransactions]

string

Example:

velit

include[building]

string

Example:

assumenda

include[billing]

string

Example:

asperiores

include[payer]

string

Retorna os dados do pagador.

Example:

id,name,type

include[account]

string

Example:

aspernatur

include[contract]

string

Retorna os dados do contrato.

Example:

include[business]

string

Retorna os dados da empresa.

Example:

id,name

include[lateFeeItem]

string

Example:

eveniet

include[files]

string

Retorna os anexos da fatura.

Example:

id,name,file_name

include[tags]

string

Retorna as tags.

Example:

id,description

include[messages]

string

Retorna as mensagens referente à fatura.

Example:

id,type,Message

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/invoices?sort=id&fields=id%2Ctype%2Ctotal&filter%5Bid%5D=1&filter%5Bid2%5D=1&filter%5Btype%5D=single&filter%5Bpayer_id%5D=1&filter%5Bcontract_id%5D=2&filter%5Bbusiness_id%5D=3&filter%5Baccount_id%5D=4&filter%5Bbilling_id%5D=5&filter%5Bbilling_method%5D=pix&filter%5Bpaid%5D=1&filter%5Bpaid_at%5D=2024-01-01&filter%5Bcredit_at%5D=2024-01-02&filter%5Bpayment_error%5D=1&filter%5Bdescription%5D=Fatura+X&filter%5Btotal%5D=1200&filter%5Bdate%5D=2024-01-01&filter%5Bdue_date%5D=2024-01-10&filter%5Bguaranteed_transfer%5D=1&filter%5Bperiod_initial%5D=2024-01-01&filter%5Bperiod_final%5D=2024-01-31&filter%5Btag%5D[]=123&filter%5Btag%5D[]=456&filter%5Btag%5D[]=789&filter%5Bticket_registered%5D=&filter%5Bticket_date%5D=2024-01-01+00%3A00%3A00&filter%5Bticket_key%5D=abc123&filter%5Bticket_id%5D=1&filter%5Bticket_fee%5D=12.0&filter%5Bticket_link%5D=https%3A%2F%2Fapi.pjbank.com.br%2Fboletos%2F823a8ee8043b3a96e2df963bead9gg63e5ea16c1&filter%5Bticket_barcode%5D=12395828200001760000010003821587100516853008&filter%5Bticket_info%5D=Este+boleto...&filter%5Bticket_digitable%5D=12390.01007+03821.587106+05168.530086+5+82820000176000&filter%5Bticket_without_pix%5D=&filter%5Bticket_late_fee%5D=1&filter%5Bticket_late_fee_item_id%5D=1&filter%5Bticket_late_fee_percentage%5D=12&filter%5Bticket_late_fee_interest%5D=13&filter%5Bticket_discount%5D=1&filter%5Bticket_discount_mode%5D=percentage&filter%5Bticket_discount_fixed%5D=123.20&filter%5Bticket_discount_percentage%5D=10&filter%5Bticket_discount_action%5D=business&filter%5Bticket_discount_days%5D=12&filter%5Btransfer_auto_disabled%5D=&filter%5Bprotest%5D=%7B%22status%22%3A%22PENDING%22%7D&filter%5BticketIdIn%5D%5B%5D=&filter%5BidOldIn%5D%5B%5D=100&filter%5BreferenceId%5D=REF-001&filter%5BemptyProtest%5D=1&filter%5BprotestIdIn%5D%5B%5D=1&filter%5Bunpaid%5D=1&filter%5Boverdue%5D=1&filter%5Bearly%5D=1&filter%5BcontractIn%5D%5B%5D=1&filter%5BcontractIdIn%5D%5B%5D=&filter%5BbuildingIn%5D%5B%5D=10&filter%5BbuildingId2In%5D%5B%5D=&filter%5BdateMin%5D=2024-01-01&filter%5BdateMax%5D=2024-01-31&filter%5BdueDateMin%5D=2024-01-10&filter%5BbusinessIn%5D%5B%5D=1&filter%5BaccountIn%5D%5B%5D=3&filter%5BpayerIn%5D%5B%5D=5&filter%5BownerIn%5D%5B%5D=7&filter%5BtenantIn%5D%5B%5D=9&filter%5Bregistered%5D=1&filter%5BregisteredOrPix%5D=1&filter%5BbillingMethodIn%5D%5B%5D=&filter%5BtagIn%5D%5B%5D=100&filter%5BautoTransferStatus%5D%5B%5D=&filter%5BperiodContains%5D=2024-01-15&filter%5BpayerTaxIdIn%5D%5B%5D=000.000.000-00&include%5Bitems%5D=dignissimos&include%5BitemsPayer%5D=in&include%5BitemsAllGroupTransfer%5D=sunt&include%5BitemsAll%5D=quo&include%5BautoTransactions%5D=velit&include%5Bbuilding%5D=assumenda&include%5Bbilling%5D=asperiores&include%5Bpayer%5D=id%2Cname%2Ctype&include%5Baccount%5D=aspernatur&include%5Bcontract%5D=%2A&include%5Bbusiness%5D=id%2Cname&include%5BlateFeeItem%5D=eveniet&include%5Bfiles%5D=id%2Cname%2Cfile_name&include%5Btags%5D=id%2Cdescription&include%5Bmessages%5D=id%2Ctype%2CMessage" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.apresenta.me/invoices"
);

const params = {
    "sort": "id",
    "fields": "id,type,total",
    "filter[id]": "1",
    "filter[id2]": "1",
    "filter[type]": "single",
    "filter[payer_id]": "1",
    "filter[contract_id]": "2",
    "filter[business_id]": "3",
    "filter[account_id]": "4",
    "filter[billing_id]": "5",
    "filter[billing_method]": "pix",
    "filter[paid]": "1",
    "filter[paid_at]": "2024-01-01",
    "filter[credit_at]": "2024-01-02",
    "filter[payment_error]": "1",
    "filter[description]": "Fatura X",
    "filter[total]": "1200",
    "filter[date]": "2024-01-01",
    "filter[due_date]": "2024-01-10",
    "filter[guaranteed_transfer]": "1",
    "filter[period_initial]": "2024-01-01",
    "filter[period_final]": "2024-01-31",
    "filter[tag][0]": "123",
    "filter[tag][1]": "456",
    "filter[tag][2]": "789",
    "filter[ticket_registered]": "0",
    "filter[ticket_date]": "2024-01-01 00:00:00",
    "filter[ticket_key]": "abc123",
    "filter[ticket_id]": "1",
    "filter[ticket_fee]": "12.0",
    "filter[ticket_link]": "https://api.pjbank.com.br/boletos/823a8ee8043b3a96e2df963bead9gg63e5ea16c1",
    "filter[ticket_barcode]": "12395828200001760000010003821587100516853008",
    "filter[ticket_info]": "Este boleto...",
    "filter[ticket_digitable]": "12390.01007 03821.587106 05168.530086 5 82820000176000",
    "filter[ticket_without_pix]": "0",
    "filter[ticket_late_fee]": "1",
    "filter[ticket_late_fee_item_id]": "1",
    "filter[ticket_late_fee_percentage]": "12",
    "filter[ticket_late_fee_interest]": "13",
    "filter[ticket_discount]": "1",
    "filter[ticket_discount_mode]": "percentage",
    "filter[ticket_discount_fixed]": "123.20",
    "filter[ticket_discount_percentage]": "10",
    "filter[ticket_discount_action]": "business",
    "filter[ticket_discount_days]": "12",
    "filter[transfer_auto_disabled]": "0",
    "filter[protest]": "{"status":"PENDING"}",
    "filter[ticketIdIn][]": "",
    "filter[idOldIn][]": "100",
    "filter[referenceId]": "REF-001",
    "filter[emptyProtest]": "1",
    "filter[protestIdIn][]": "1",
    "filter[unpaid]": "1",
    "filter[overdue]": "1",
    "filter[early]": "1",
    "filter[contractIn][]": "1",
    "filter[contractIdIn][]": "",
    "filter[buildingIn][]": "10",
    "filter[buildingId2In][]": "",
    "filter[dateMin]": "2024-01-01",
    "filter[dateMax]": "2024-01-31",
    "filter[dueDateMin]": "2024-01-10",
    "filter[businessIn][]": "1",
    "filter[accountIn][]": "3",
    "filter[payerIn][]": "5",
    "filter[ownerIn][]": "7",
    "filter[tenantIn][]": "9",
    "filter[registered]": "1",
    "filter[registeredOrPix]": "1",
    "filter[billingMethodIn][]": "",
    "filter[tagIn][]": "100",
    "filter[autoTransferStatus][]": "",
    "filter[periodContains]": "2024-01-15",
    "filter[payerTaxIdIn][]": "000.000.000-00",
    "include[items]": "dignissimos",
    "include[itemsPayer]": "in",
    "include[itemsAllGroupTransfer]": "sunt",
    "include[itemsAll]": "quo",
    "include[autoTransactions]": "velit",
    "include[building]": "assumenda",
    "include[billing]": "asperiores",
    "include[payer]": "id,name,type",
    "include[account]": "aspernatur",
    "include[contract]": "*",
    "include[business]": "id,name",
    "include[lateFeeItem]": "eveniet",
    "include[files]": "id,name,file_name",
    "include[tags]": "id,description",
    "include[messages]": "id,type,Message",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/invoices';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'sort' => 'id',
            'fields' => 'id,type,total',
            'filter[id]' => '1',
            'filter[id2]' => '1',
            'filter[type]' => 'single',
            'filter[payer_id]' => '1',
            'filter[contract_id]' => '2',
            'filter[business_id]' => '3',
            'filter[account_id]' => '4',
            'filter[billing_id]' => '5',
            'filter[billing_method]' => 'pix',
            'filter[paid]' => '1',
            'filter[paid_at]' => '2024-01-01',
            'filter[credit_at]' => '2024-01-02',
            'filter[payment_error]' => '1',
            'filter[description]' => 'Fatura X',
            'filter[total]' => '1200',
            'filter[date]' => '2024-01-01',
            'filter[due_date]' => '2024-01-10',
            'filter[guaranteed_transfer]' => '1',
            'filter[period_initial]' => '2024-01-01',
            'filter[period_final]' => '2024-01-31',
            'filter[tag][0]' => '123',
            'filter[tag][1]' => '456',
            'filter[tag][2]' => '789',
            'filter[ticket_registered]' => '0',
            'filter[ticket_date]' => '2024-01-01 00:00:00',
            'filter[ticket_key]' => 'abc123',
            'filter[ticket_id]' => '1',
            'filter[ticket_fee]' => '12.0',
            'filter[ticket_link]' => 'https://api.pjbank.com.br/boletos/823a8ee8043b3a96e2df963bead9gg63e5ea16c1',
            'filter[ticket_barcode]' => '12395828200001760000010003821587100516853008',
            'filter[ticket_info]' => 'Este boleto...',
            'filter[ticket_digitable]' => '12390.01007 03821.587106 05168.530086 5 82820000176000',
            'filter[ticket_without_pix]' => '0',
            'filter[ticket_late_fee]' => '1',
            'filter[ticket_late_fee_item_id]' => '1',
            'filter[ticket_late_fee_percentage]' => '12',
            'filter[ticket_late_fee_interest]' => '13',
            'filter[ticket_discount]' => '1',
            'filter[ticket_discount_mode]' => 'percentage',
            'filter[ticket_discount_fixed]' => '123.20',
            'filter[ticket_discount_percentage]' => '10',
            'filter[ticket_discount_action]' => 'business',
            'filter[ticket_discount_days]' => '12',
            'filter[transfer_auto_disabled]' => '0',
            'filter[protest]' => '{"status":"PENDING"}',
            'filter[ticketIdIn][]' => '',
            'filter[idOldIn][]' => '100',
            'filter[referenceId]' => 'REF-001',
            'filter[emptyProtest]' => '1',
            'filter[protestIdIn][]' => '1',
            'filter[unpaid]' => '1',
            'filter[overdue]' => '1',
            'filter[early]' => '1',
            'filter[contractIn][]' => '1',
            'filter[contractIdIn][]' => '',
            'filter[buildingIn][]' => '10',
            'filter[buildingId2In][]' => '',
            'filter[dateMin]' => '2024-01-01',
            'filter[dateMax]' => '2024-01-31',
            'filter[dueDateMin]' => '2024-01-10',
            'filter[businessIn][]' => '1',
            'filter[accountIn][]' => '3',
            'filter[payerIn][]' => '5',
            'filter[ownerIn][]' => '7',
            'filter[tenantIn][]' => '9',
            'filter[registered]' => '1',
            'filter[registeredOrPix]' => '1',
            'filter[billingMethodIn][]' => '',
            'filter[tagIn][]' => '100',
            'filter[autoTransferStatus][]' => '',
            'filter[periodContains]' => '2024-01-15',
            'filter[payerTaxIdIn][]' => '000.000.000-00',
            'include[items]' => 'dignissimos',
            'include[itemsPayer]' => 'in',
            'include[itemsAllGroupTransfer]' => 'sunt',
            'include[itemsAll]' => 'quo',
            'include[autoTransactions]' => 'velit',
            'include[building]' => 'assumenda',
            'include[billing]' => 'asperiores',
            'include[payer]' => 'id,name,type',
            'include[account]' => 'aspernatur',
            'include[contract]' => '*',
            'include[business]' => 'id,name',
            'include[lateFeeItem]' => 'eveniet',
            'include[files]' => 'id,name,file_name',
            'include[tags]' => 'id,description',
            'include[messages]' => 'id,type,Message',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.apresenta.me/invoices'
params = {
  'sort': 'id',
  'fields': 'id,type,total',
  'filter[id]': '1',
  'filter[id2]': '1',
  'filter[type]': 'single',
  'filter[payer_id]': '1',
  'filter[contract_id]': '2',
  'filter[business_id]': '3',
  'filter[account_id]': '4',
  'filter[billing_id]': '5',
  'filter[billing_method]': 'pix',
  'filter[paid]': '1',
  'filter[paid_at]': '2024-01-01',
  'filter[credit_at]': '2024-01-02',
  'filter[payment_error]': '1',
  'filter[description]': 'Fatura X',
  'filter[total]': '1200',
  'filter[date]': '2024-01-01',
  'filter[due_date]': '2024-01-10',
  'filter[guaranteed_transfer]': '1',
  'filter[period_initial]': '2024-01-01',
  'filter[period_final]': '2024-01-31',
  'filter[tag][0]': '123',
  'filter[tag][1]': '456',
  'filter[tag][2]': '789',
  'filter[ticket_registered]': '0',
  'filter[ticket_date]': '2024-01-01 00:00:00',
  'filter[ticket_key]': 'abc123',
  'filter[ticket_id]': '1',
  'filter[ticket_fee]': '12.0',
  'filter[ticket_link]': 'https://api.pjbank.com.br/boletos/823a8ee8043b3a96e2df963bead9gg63e5ea16c1',
  'filter[ticket_barcode]': '12395828200001760000010003821587100516853008',
  'filter[ticket_info]': 'Este boleto...',
  'filter[ticket_digitable]': '12390.01007 03821.587106 05168.530086 5 82820000176000',
  'filter[ticket_without_pix]': '0',
  'filter[ticket_late_fee]': '1',
  'filter[ticket_late_fee_item_id]': '1',
  'filter[ticket_late_fee_percentage]': '12',
  'filter[ticket_late_fee_interest]': '13',
  'filter[ticket_discount]': '1',
  'filter[ticket_discount_mode]': 'percentage',
  'filter[ticket_discount_fixed]': '123.20',
  'filter[ticket_discount_percentage]': '10',
  'filter[ticket_discount_action]': 'business',
  'filter[ticket_discount_days]': '12',
  'filter[transfer_auto_disabled]': '0',
  'filter[protest]': '{"status":"PENDING"}',
  'filter[ticketIdIn][]': '',
  'filter[idOldIn][]': '100',
  'filter[referenceId]': 'REF-001',
  'filter[emptyProtest]': '1',
  'filter[protestIdIn][]': '1',
  'filter[unpaid]': '1',
  'filter[overdue]': '1',
  'filter[early]': '1',
  'filter[contractIn][]': '1',
  'filter[contractIdIn][]': '',
  'filter[buildingIn][]': '10',
  'filter[buildingId2In][]': '',
  'filter[dateMin]': '2024-01-01',
  'filter[dateMax]': '2024-01-31',
  'filter[dueDateMin]': '2024-01-10',
  'filter[businessIn][]': '1',
  'filter[accountIn][]': '3',
  'filter[payerIn][]': '5',
  'filter[ownerIn][]': '7',
  'filter[tenantIn][]': '9',
  'filter[registered]': '1',
  'filter[registeredOrPix]': '1',
  'filter[billingMethodIn][]': '',
  'filter[tagIn][]': '100',
  'filter[autoTransferStatus][]': '',
  'filter[periodContains]': '2024-01-15',
  'filter[payerTaxIdIn][]': '000.000.000-00',
  'include[items]': 'dignissimos',
  'include[itemsPayer]': 'in',
  'include[itemsAllGroupTransfer]': 'sunt',
  'include[itemsAll]': 'quo',
  'include[autoTransactions]': 'velit',
  'include[building]': 'assumenda',
  'include[billing]': 'asperiores',
  'include[payer]': 'id,name,type',
  'include[account]': 'aspernatur',
  'include[contract]': '*',
  'include[business]': 'id,name',
  'include[lateFeeItem]': 'eveniet',
  'include[files]': 'id,name,file_name',
  'include[tags]': 'id,description',
  'include[messages]': 'id,type,Message',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/invoices

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

type

string

required

Tipo da fatura. Valores permitidos:

single: Avulsa
contract: Contrato

Example:

single

payer_id

integer

required

ID do pagador.

Example:

business_id

integer

required

ID da empresa.

Example:

account_id

integer

required

ID da conta bancária.

Example:

description

string

required

Descrição da fatura.

Example:

Fatura X

total

number

required

Valor total da fatura.

Example:

1200

date

string

required

Competência.

Example:

2024-01-01

due_date

string

required

Data de vencimento.

Example:

2024-01-10

items

json[]

required

Itens para fatura.

Example:

[{"item_id":34,"amount":1200}]

contract_id

integer

ID do contrato.

Example:

billing_id

integer

ID do método de cobrança automático.

Example:

billing_method

string

required

Método de cobrança Valores permitidos:

ticket: Boleto
cash: Dinheiro
deposit: Depósito
pix: PIX
ted: DOC/TED
credit: Cartão de Crédito
debit: Cartão de Débito
check: Cheque
debit_account: Débito em Conta

Example:

pix

paid

boolean

Paga. Pode ser true (Pago) ou false (Agendado/Não Pago).

paid_at

string

Data do pagamento.

Example:

2024-01-01

credit_at

string

Data do crédito.

Example:

2024-01-02

payment_error

boolean

Erro no pagamento.

Example:

guaranteed_transfer

boolean

Repasse garantido.

Example:

period_initial

string

Data de início da fatura, aluguel.

Example:

2024-01-01

period_final

string

Data final da fatura, aluguel.

Example:

2024-01-31

tag

string[]

Tags da fatura.

Example:

[123,456,789]

ticket_registered

boolean

Boleto registrado.

ticket_date

string

Data do boleto.

Example:

2024-01-01 00:00:00

ticket_key

string

ID da cobrança dentro do banco integrador (Asaas).

Example:

abc123

ticket_id

integer

ID do boleto.

Example:

ticket_fee

string

Taxa do boleto.

Example:

12.0

ticket_link

string

Link do boleto.

Example:

https://api.pjbank.com.br/boletos/823a8ee8043b3a96e2df963bead9gg63e5ea16c1

ticket_barcode

string

Código de barras do boleto .

Example:

12395828200001760000010003821587100516853008

ticket_info

string

Informações do boleto.

Example:

Este boleto...

ticket_digitable

string

Linha digitável do boleto.

Example:

12390.01007 03821.587106 05168.530086 5 82820000176000

ticket_without_pix

boolean

Boleto sem pix.

ticket_late_fee

boolean

Adicionar Multa e Juros para contratos de Locação.

Example:

ticket_late_fee_item_id

integer

ID do item que será aplicado a multa.

Example:

ticket_late_fee_percentage

integer

Multa (%).

Example:

ticket_late_fee_interest

integer

Juros (%).

Example:

ticket_discount

boolean

Adicionar Desconto de Pontualidade.

Example:

ticket_discount_mode

string

Modo de desconto. Valores permitidos:

fixed: Valor Fixo
percentage: Porcentagem

Example:

percentage

ticket_discount_fixed

string

Desconto (R$).

Example:

123.20

ticket_discount_percentage

string

Desconto(%).

Example:

ticket_discount_action

string

Ação do desconto de pontualidade. Valores permitidos:

business: Reter desconto para imobiliária
owner: Repassar desconto ao proprietário

Example:

business

ticket_discount_days

integer

Quantidade de dias antes do vencimento.

Example:

transfer_auto_disabled

boolean

Desativar repasse automático.

protest

json

Protesto.

Example:

{"status":"PENDING"}

Auth

Bearer

Headers

Body

{ "type": "single", "payer_id": 1, "business_id": 3, "account_id": 4, "description": "Fatura X", "total": 1200, "date": "2024-01-01", "due_date": "2024-01-10", "items": [ { "item_id": 34, "amount": 1200 } ], "contract_id": 2, "billing_id": 5, "billing_method": "pix", "paid": false, "paid_at": "2024-01-01", "credit_at": "2024-01-02", "payment_error": true, "guaranteed_transfer": true, "period_initial": "2024-01-01", "period_final": "2024-01-31", "tag": [ 123, 456, 789 ], "ticket_registered": false, "ticket_date": "2024-01-01 00:00:00", "ticket_key": "abc123", "ticket_id": 1, "ticket_fee": "12.0", "ticket_link": "https:\/\/api.pjbank.com.br\/boletos\/823a8ee8043b3a96e2df963bead9gg63e5ea16c1", "ticket_barcode": "12395828200001760000010003821587100516853008", "ticket_info": "Este boleto...", "ticket_digitable": "12390.01007 03821.587106 05168.530086 5 82820000176000", "ticket_without_pix": false, "ticket_late_fee": true, "ticket_late_fee_item_id": 1, "ticket_late_fee_percentage": 12, "ticket_late_fee_interest": 13, "ticket_discount": true, "ticket_discount_mode": "percentage", "ticket_discount_fixed": "123.20", "ticket_discount_percentage": "10", "ticket_discount_action": "business", "ticket_discount_days": 12, "transfer_auto_disabled": false, "protest": "{\"status\":\"PENDING\"}" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/invoices" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"single\",
    \"payer_id\": 1,
    \"business_id\": 3,
    \"account_id\": 4,
    \"description\": \"Fatura X\",
    \"total\": 1200,
    \"date\": \"2024-01-01\",
    \"due_date\": \"2024-01-10\",
    \"items\": [
        {
            \"item_id\": 34,
            \"amount\": 1200
        }
    ],
    \"contract_id\": 2,
    \"billing_id\": 5,
    \"billing_method\": \"pix\",
    \"paid\": false,
    \"paid_at\": \"2024-01-01\",
    \"credit_at\": \"2024-01-02\",
    \"payment_error\": true,
    \"guaranteed_transfer\": true,
    \"period_initial\": \"2024-01-01\",
    \"period_final\": \"2024-01-31\",
    \"tag\": [
        123,
        456,
        789
    ],
    \"ticket_registered\": false,
    \"ticket_date\": \"2024-01-01 00:00:00\",
    \"ticket_key\": \"abc123\",
    \"ticket_id\": 1,
    \"ticket_fee\": \"12.0\",
    \"ticket_link\": \"https:\\/\\/api.pjbank.com.br\\/boletos\\/823a8ee8043b3a96e2df963bead9gg63e5ea16c1\",
    \"ticket_barcode\": \"12395828200001760000010003821587100516853008\",
    \"ticket_info\": \"Este boleto...\",
    \"ticket_digitable\": \"12390.01007 03821.587106 05168.530086 5 82820000176000\",
    \"ticket_without_pix\": false,
    \"ticket_late_fee\": true,
    \"ticket_late_fee_item_id\": 1,
    \"ticket_late_fee_percentage\": 12,
    \"ticket_late_fee_interest\": 13,
    \"ticket_discount\": true,
    \"ticket_discount_mode\": \"percentage\",
    \"ticket_discount_fixed\": \"123.20\",
    \"ticket_discount_percentage\": \"10\",
    \"ticket_discount_action\": \"business\",
    \"ticket_discount_days\": 12,
    \"transfer_auto_disabled\": false,
    \"protest\": \"{\\\"status\\\":\\\"PENDING\\\"}\"
}"

const url = new URL(
    "https://api.apresenta.me/invoices"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "single",
    "payer_id": 1,
    "business_id": 3,
    "account_id": 4,
    "description": "Fatura X",
    "total": 1200,
    "date": "2024-01-01",
    "due_date": "2024-01-10",
    "items": [
        {
            "item_id": 34,
            "amount": 1200
        }
    ],
    "contract_id": 2,
    "billing_id": 5,
    "billing_method": "pix",
    "paid": false,
    "paid_at": "2024-01-01",
    "credit_at": "2024-01-02",
    "payment_error": true,
    "guaranteed_transfer": true,
    "period_initial": "2024-01-01",
    "period_final": "2024-01-31",
    "tag": [
        123,
        456,
        789
    ],
    "ticket_registered": false,
    "ticket_date": "2024-01-01 00:00:00",
    "ticket_key": "abc123",
    "ticket_id": 1,
    "ticket_fee": "12.0",
    "ticket_link": "https:\/\/api.pjbank.com.br\/boletos\/823a8ee8043b3a96e2df963bead9gg63e5ea16c1",
    "ticket_barcode": "12395828200001760000010003821587100516853008",
    "ticket_info": "Este boleto...",
    "ticket_digitable": "12390.01007 03821.587106 05168.530086 5 82820000176000",
    "ticket_without_pix": false,
    "ticket_late_fee": true,
    "ticket_late_fee_item_id": 1,
    "ticket_late_fee_percentage": 12,
    "ticket_late_fee_interest": 13,
    "ticket_discount": true,
    "ticket_discount_mode": "percentage",
    "ticket_discount_fixed": "123.20",
    "ticket_discount_percentage": "10",
    "ticket_discount_action": "business",
    "ticket_discount_days": 12,
    "transfer_auto_disabled": false,
    "protest": "{\"status\":\"PENDING\"}"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/invoices';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => \Symfony\Component\VarExporter\Internal\Hydrator::hydrate(
            $o = [
                clone (\Symfony\Component\VarExporter\Internal\Registry::$prototypes['stdClass'] ?? \Symfony\Component\VarExporter\Internal\Registry::p('stdClass')),
            ],
            null,
            [
                'stdClass' => [
                    'item_id' => [
                        34,
                    ],
                    'amount' => [
                        1200,
                    ],
                ],
            ],
            [
                'type' => 'single',
                'payer_id' => 1,
                'business_id' => 3,
                'account_id' => 4,
                'description' => 'Fatura X',
                'total' => 1200.0,
                'date' => '2024-01-01',
                'due_date' => '2024-01-10',
                'items' => [
                    $o[0],
                ],
                'contract_id' => 2,
                'billing_id' => 5,
                'billing_method' => 'pix',
                'paid' => false,
                'paid_at' => '2024-01-01',
                'credit_at' => '2024-01-02',
                'payment_error' => true,
                'guaranteed_transfer' => true,
                'period_initial' => '2024-01-01',
                'period_final' => '2024-01-31',
                'tag' => [
                    123,
                    456,
                    789,
                ],
                'ticket_registered' => false,
                'ticket_date' => '2024-01-01 00:00:00',
                'ticket_key' => 'abc123',
                'ticket_id' => 1,
                'ticket_fee' => '12.0',
                'ticket_link' => 'https://api.pjbank.com.br/boletos/823a8ee8043b3a96e2df963bead9gg63e5ea16c1',
                'ticket_barcode' => '12395828200001760000010003821587100516853008',
                'ticket_info' => 'Este boleto...',
                'ticket_digitable' => '12390.01007 03821.587106 05168.530086 5 82820000176000',
                'ticket_without_pix' => false,
                'ticket_late_fee' => true,
                'ticket_late_fee_item_id' => 1,
                'ticket_late_fee_percentage' => 12,
                'ticket_late_fee_interest' => 13,
                'ticket_discount' => true,
                'ticket_discount_mode' => 'percentage',
                'ticket_discount_fixed' => '123.20',
                'ticket_discount_percentage' => '10',
                'ticket_discount_action' => 'business',
                'ticket_discount_days' => 12,
                'transfer_auto_disabled' => false,
                'protest' => '{"status":"PENDING"}',
            ],
            []
        ),
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.apresenta.me/invoices'
payload = {
    "type": "single",
    "payer_id": 1,
    "business_id": 3,
    "account_id": 4,
    "description": "Fatura X",
    "total": 1200,
    "date": "2024-01-01",
    "due_date": "2024-01-10",
    "items": [
        {
            "item_id": 34,
            "amount": 1200
        }
    ],
    "contract_id": 2,
    "billing_id": 5,
    "billing_method": "pix",
    "paid": false,
    "paid_at": "2024-01-01",
    "credit_at": "2024-01-02",
    "payment_error": true,
    "guaranteed_transfer": true,
    "period_initial": "2024-01-01",
    "period_final": "2024-01-31",
    "tag": [
        123,
        456,
        789
    ],
    "ticket_registered": false,
    "ticket_date": "2024-01-01 00:00:00",
    "ticket_key": "abc123",
    "ticket_id": 1,
    "ticket_fee": "12.0",
    "ticket_link": "https:\/\/api.pjbank.com.br\/boletos\/823a8ee8043b3a96e2df963bead9gg63e5ea16c1",
    "ticket_barcode": "12395828200001760000010003821587100516853008",
    "ticket_info": "Este boleto...",
    "ticket_digitable": "12390.01007 03821.587106 05168.530086 5 82820000176000",
    "ticket_without_pix": false,
    "ticket_late_fee": true,
    "ticket_late_fee_item_id": 1,
    "ticket_late_fee_percentage": 12,
    "ticket_late_fee_interest": 13,
    "ticket_discount": true,
    "ticket_discount_mode": "percentage",
    "ticket_discount_fixed": "123.20",
    "ticket_discount_percentage": "10",
    "ticket_discount_action": "business",
    "ticket_discount_days": 12,
    "transfer_auto_disabled": false,
    "protest": "{\"status\":\"PENDING\"}"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Obter

GET

https://api.apresenta.me/invoices/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da Fatura

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,type,total

include[items]

string

Example:

eum

include[itemsPayer]

string

Example:

provident

include[itemsAllGroupTransfer]

string

Example:

deserunt

include[itemsAll]

string

Example:

laboriosam

include[autoTransactions]

string

Example:

include[building]

string

Example:

atque

include[billing]

string

Example:

asperiores

include[payer]

string

Retorna os dados do pagador.

Example:

id,name,type

include[account]

string

Example:

include[contract]

string

Retorna os dados do contrato.

Example:

include[business]

string

Retorna os dados da empresa.

Example:

id,name

include[lateFeeItem]

string

Example:

include[files]

string

Retorna os anexos da fatura.

Example:

id,name,file_name

include[tags]

string

Retorna as tags.

Example:

id,description

include[messages]

string

Retorna as mensagens referente à fatura.

Example:

id,type,message

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/invoices/4?sort=id&fields=id%2Ctype%2Ctotal&include%5Bitems%5D=eum&include%5BitemsPayer%5D=provident&include%5BitemsAllGroupTransfer%5D=deserunt&include%5BitemsAll%5D=laboriosam&include%5BautoTransactions%5D=et&include%5Bbuilding%5D=atque&include%5Bbilling%5D=asperiores&include%5Bpayer%5D=id%2Cname%2Ctype&include%5Baccount%5D=ut&include%5Bcontract%5D=%2A&include%5Bbusiness%5D=id%2Cname&include%5BlateFeeItem%5D=ea&include%5Bfiles%5D=id%2Cname%2Cfile_name&include%5Btags%5D=id%2Cdescription&include%5Bmessages%5D=id%2Ctype%2Cmessage" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/invoices/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id da Fatura

Example:

Body Parameters

type

string

Tipo da fatura. Valores permitidos:

single: Avulsa
contract: Contrato

Example:

single

payer_id

integer

ID do pagador.

Example:

contract_id

integer

ID do contrato.

Example:

business_id

integer

ID da empresa.

Example:

account_id

integer

ID da conta bancária.

Example:

billing_id

integer

ID do método de cobrança automático.

Example:

billing_method

string

required

Método de cobrança Valores permitidos:

ticket: Boleto
cash: Dinheiro
deposit: Depósito
pix: PIX
ted: DOC/TED
credit: Cartão de Crédito
debit: Cartão de Débito
check: Cheque
debit_account: Débito em Conta

Example:

pix

paid

boolean

Paga. Pode ser true (Pago) ou false (Agendado/Não Pago).

paid_at

string

Data do pagamento.

Example:

2024-01-01

credit_at

string

Data do crédito.

Example:

2024-01-02

payment_error

boolean

Erro no pagamento.

Example:

description

string

Descrição da fatura.

Example:

Fatura X

total

number

Valor total da fatura.

Example:

1200

date

string

Competência.

Example:

2024-01-01

due_date

string

Data de vencimento.

Example:

2024-01-10

items

json[]

Itens para fatura.

Adicionar: {"item_id": 34, "amount": 100, "description": "Item 1"}
Editar: {"id": 1, "item_id": 34, "amount": 150, "description": "Item 1 Editado"}
Excluir: {"id": 1, "item_id": 34, "delete": true}

guaranteed_transfer

boolean

Repasse garantido.

Example:

period_initial

string

Data de início da fatura, aluguel.

Example:

2024-01-01

period_final

string

Data final da fatura, aluguel.

Example:

2024-01-31

tag

string[]

Tags da fatura.

Example:

[123,456,789]

ticket_registered

boolean

Boleto registrado.

ticket_date

string

Data do boleto.

Example:

2024-01-01 00:00:00

ticket_key

string

ID da cobrança dentro do banco integrador (Asaas).

Example:

abc123

ticket_id

integer

ID do boleto.

Example:

ticket_fee

string

Taxa do boleto.

Example:

12.0

ticket_link

string

Link do boleto.

Example:

https://api.pjbank.com.br/boletos/823a8ee8043b3a96e2df963bead9gg63e5ea16c1

ticket_barcode

string

Código de barras do boleto .

Example:

12395828200001760000010003821587100516853008

ticket_info

string

Informações do boleto.

Example:

Este boleto...

ticket_digitable

string

Linha digitável do boleto.

Example:

12390.01007 03821.587106 05168.530086 5 82820000176000

ticket_without_pix

boolean

Boleto sem pix.

ticket_late_fee

boolean

Adicionar Multa e Juros para contratos de Locação.

Example:

ticket_late_fee_item_id

integer

ID do item que será aplicado a multa.

Example:

ticket_late_fee_percentage

integer

Multa (%).

Example:

ticket_late_fee_interest

integer

Juros (%).

Example:

ticket_discount

boolean

Adicionar Desconto de Pontualidade.

Example:

ticket_discount_mode

string

Modo de desconto. Valores permitidos:

fixed: Valor Fixo
percentage: Porcentagem

Example:

percentage

ticket_discount_fixed

string

Desconto (R$).

Example:

123.20

ticket_discount_percentage

string

Desconto(%).

Example:

ticket_discount_action

string

Ação do desconto de pontualidade. Valores permitidos:

business: Reter desconto para imobiliária
owner: Repassar desconto ao proprietário

Example:

business

ticket_discount_days

integer

Quantidade de dias antes do vencimento.

Example:

transfer_auto_disabled

boolean

Desativar repasse automático.

protest

json

Protesto.

Example:

{"status":"PENDING"}

Auth

Bearer

Headers

URL Parameters

Body

{ "type": "single", "payer_id": 1, "contract_id": 2, "business_id": 3, "account_id": 4, "billing_id": 5, "billing_method": "pix", "paid": false, "paid_at": "2024-01-01", "credit_at": "2024-01-02", "payment_error": true, "description": "Fatura X", "total": 1200, "date": "2024-01-01", "due_date": "2024-01-10", "items": null, "guaranteed_transfer": true, "period_initial": "2024-01-01", "period_final": "2024-01-31", "tag": [ 123, 456, 789 ], "ticket_registered": false, "ticket_date": "2024-01-01 00:00:00", "ticket_key": "abc123", "ticket_id": 1, "ticket_fee": "12.0", "ticket_link": "https:\/\/api.pjbank.com.br\/boletos\/823a8ee8043b3a96e2df963bead9gg63e5ea16c1", "ticket_barcode": "12395828200001760000010003821587100516853008", "ticket_info": "Este boleto...", "ticket_digitable": "12390.01007 03821.587106 05168.530086 5 82820000176000", "ticket_without_pix": false, "ticket_late_fee": true, "ticket_late_fee_item_id": 1, "ticket_late_fee_percentage": 12, "ticket_late_fee_interest": 13, "ticket_discount": true, "ticket_discount_mode": "percentage", "ticket_discount_fixed": "123.20", "ticket_discount_percentage": "10", "ticket_discount_action": "business", "ticket_discount_days": 12, "transfer_auto_disabled": false, "protest": "{\"status\":\"PENDING\"}" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/invoices/5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"single\",
    \"payer_id\": 1,
    \"contract_id\": 2,
    \"business_id\": 3,
    \"account_id\": 4,
    \"billing_id\": 5,
    \"billing_method\": \"pix\",
    \"paid\": false,
    \"paid_at\": \"2024-01-01\",
    \"credit_at\": \"2024-01-02\",
    \"payment_error\": true,
    \"description\": \"Fatura X\",
    \"total\": 1200,
    \"date\": \"2024-01-01\",
    \"due_date\": \"2024-01-10\",
    \"items\": null,
    \"guaranteed_transfer\": true,
    \"period_initial\": \"2024-01-01\",
    \"period_final\": \"2024-01-31\",
    \"tag\": [
        123,
        456,
        789
    ],
    \"ticket_registered\": false,
    \"ticket_date\": \"2024-01-01 00:00:00\",
    \"ticket_key\": \"abc123\",
    \"ticket_id\": 1,
    \"ticket_fee\": \"12.0\",
    \"ticket_link\": \"https:\\/\\/api.pjbank.com.br\\/boletos\\/823a8ee8043b3a96e2df963bead9gg63e5ea16c1\",
    \"ticket_barcode\": \"12395828200001760000010003821587100516853008\",
    \"ticket_info\": \"Este boleto...\",
    \"ticket_digitable\": \"12390.01007 03821.587106 05168.530086 5 82820000176000\",
    \"ticket_without_pix\": false,
    \"ticket_late_fee\": true,
    \"ticket_late_fee_item_id\": 1,
    \"ticket_late_fee_percentage\": 12,
    \"ticket_late_fee_interest\": 13,
    \"ticket_discount\": true,
    \"ticket_discount_mode\": \"percentage\",
    \"ticket_discount_fixed\": \"123.20\",
    \"ticket_discount_percentage\": \"10\",
    \"ticket_discount_action\": \"business\",
    \"ticket_discount_days\": 12,
    \"transfer_auto_disabled\": false,
    \"protest\": \"{\\\"status\\\":\\\"PENDING\\\"}\"
}"

const url = new URL(
    "https://api.apresenta.me/invoices/5"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "single",
    "payer_id": 1,
    "contract_id": 2,
    "business_id": 3,
    "account_id": 4,
    "billing_id": 5,
    "billing_method": "pix",
    "paid": false,
    "paid_at": "2024-01-01",
    "credit_at": "2024-01-02",
    "payment_error": true,
    "description": "Fatura X",
    "total": 1200,
    "date": "2024-01-01",
    "due_date": "2024-01-10",
    "items": null,
    "guaranteed_transfer": true,
    "period_initial": "2024-01-01",
    "period_final": "2024-01-31",
    "tag": [
        123,
        456,
        789
    ],
    "ticket_registered": false,
    "ticket_date": "2024-01-01 00:00:00",
    "ticket_key": "abc123",
    "ticket_id": 1,
    "ticket_fee": "12.0",
    "ticket_link": "https:\/\/api.pjbank.com.br\/boletos\/823a8ee8043b3a96e2df963bead9gg63e5ea16c1",
    "ticket_barcode": "12395828200001760000010003821587100516853008",
    "ticket_info": "Este boleto...",
    "ticket_digitable": "12390.01007 03821.587106 05168.530086 5 82820000176000",
    "ticket_without_pix": false,
    "ticket_late_fee": true,
    "ticket_late_fee_item_id": 1,
    "ticket_late_fee_percentage": 12,
    "ticket_late_fee_interest": 13,
    "ticket_discount": true,
    "ticket_discount_mode": "percentage",
    "ticket_discount_fixed": "123.20",
    "ticket_discount_percentage": "10",
    "ticket_discount_action": "business",
    "ticket_discount_days": 12,
    "transfer_auto_disabled": false,
    "protest": "{\"status\":\"PENDING\"}"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/invoices/5';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'single',
            'payer_id' => 1,
            'contract_id' => 2,
            'business_id' => 3,
            'account_id' => 4,
            'billing_id' => 5,
            'billing_method' => 'pix',
            'paid' => false,
            'paid_at' => '2024-01-01',
            'credit_at' => '2024-01-02',
            'payment_error' => true,
            'description' => 'Fatura X',
            'total' => 1200.0,
            'date' => '2024-01-01',
            'due_date' => '2024-01-10',
            'items' => null,
            'guaranteed_transfer' => true,
            'period_initial' => '2024-01-01',
            'period_final' => '2024-01-31',
            'tag' => [
                123,
                456,
                789,
            ],
            'ticket_registered' => false,
            'ticket_date' => '2024-01-01 00:00:00',
            'ticket_key' => 'abc123',
            'ticket_id' => 1,
            'ticket_fee' => '12.0',
            'ticket_link' => 'https://api.pjbank.com.br/boletos/823a8ee8043b3a96e2df963bead9gg63e5ea16c1',
            'ticket_barcode' => '12395828200001760000010003821587100516853008',
            'ticket_info' => 'Este boleto...',
            'ticket_digitable' => '12390.01007 03821.587106 05168.530086 5 82820000176000',
            'ticket_without_pix' => false,
            'ticket_late_fee' => true,
            'ticket_late_fee_item_id' => 1,
            'ticket_late_fee_percentage' => 12,
            'ticket_late_fee_interest' => 13,
            'ticket_discount' => true,
            'ticket_discount_mode' => 'percentage',
            'ticket_discount_fixed' => '123.20',
            'ticket_discount_percentage' => '10',
            'ticket_discount_action' => 'business',
            'ticket_discount_days' => 12,
            'transfer_auto_disabled' => false,
            'protest' => '{"status":"PENDING"}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Excluir

DELETE

https://api.apresenta.me/invoices/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da Fatura

Example:

Body Parameters

removeLiquidated

boolean

Caso informado, será removido a fatura mesmo que esteja liquidada

Example:

removeWithFiscalNote

boolean

Caso informado, será removido a fatura mesmo que alguma nota fiscal fora laçada vinculada a um item desta fatura

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "removeLiquidated": true, "removeWithFiscalNote": true }

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/invoices/7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"removeLiquidated\": true,
    \"removeWithFiscalNote\": true
}"

Contas a Pagar e Receber

Pesquisar

GET

https://api.apresenta.me/transactions

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,type,total

filter[id]

string

ID do lançamento.

Example:

filter[company_id]

integer

ID da empresa.

Example:

filter[split]

string

Filtra lançamentos por ID de agrupamento

Example:

filter[invoice_id]

integer

ID da fatura.

Example:

filter[transfer_id]

integer

ID da transferência.

Example:

filter[morph_key]

string

Chave do módulo.

Example:

invoice

filter[mode]

string

Modo do lançamento. Valores permitidos:

transaction: Lançamentos
invoice: Faturas
transfer: Repasses
commission: Comissões
transfer_commission: Repasses de Comissões
guaranteed_rent: Aluguel Garantido
chargeback: Estornos

Example:

transaction

filter[type]

string

Tipo do lançamento. Valores permitidos:

debit: Despesa
credit: Crédito
transfer: Transferência

Example:

debit

filter[account_id]

integer

ID da conta bancária.

Example:

filter[business_id]

integer

ID da empresa.

Example:

filter[plan_id]

integer

ID do plano de contas.

Example:

filter[user_id]

integer

ID do usuário.

Example:

filter[item_id]

integer

ID do item.

Example:

filter[guaranteed_transfer_id]

integer

ID da transferência garantida.

Example:

filter[person_id]

integer

ID da pessoa.

Example:

filter[building_id]

integer

ID do imóvel.

Example:

filter[contract_id]

integer

ID do contrato.

Example:

filter[broker_id]

integer

ID do corretor.

Example:

filter[owner_id]

integer

ID do proprietário.

Example:

filter[tenant_id]

integer

ID do inquilino.

Example:

filter[extract]

string

Extrato. Valores permitidos:

business: Imobiliária/Empresa
owner: Proprietário
customer: Cliente
broker: Corretor/Vendedor

Example:

owner

filter[date]

string

date Data do lançamento.

Example:

2024-01-01

filter[position]

integer

Posição.

Example:

filter[amount]

string

decimal Valor.

Example:

100.00

filter[amount_primary]

string

decimal Valor original.

Example:

100.00

filter[percentage]

string

decimal Porcentagem.

Example:

10.00

filter[competence]

string

date Competência.

Example:

2024-01-01

filter[description]

string

Descrição.

Example:

Conta de Luz

filter[paid]

boolean

Filtra lançamentos pagos

Example:

filter[due_date]

string

date Data de vencimento.

Example:

2024-01-10

filter[billing_method]

string

Método de cobrança. Valores permitidos:

ticket: Boleto
cash: Dinheiro
deposit: Depósito
pix: PIX
ted: DOC/TED
credit: Cartão de Crédito
debit: Cartão de Débito
check: Cheque
debit_account: Débito em Conta

Example:

pix

filter[onlyVisible]

boolean

Filtra apenas lançamentos visíveis

Example:

filter[transfer]

boolean

Filtra lançamentos do modo transferência

Example:

filter[brokerTransfer]

boolean

Filtra lançamentos do modo transferência de comissão

Example:

filter[autoTransfer]

boolean

Filtra lançamentos de transferência automática

Example:

filter[manualTransfer]

boolean

Filtra lançamentos de transferência manual

Example:

filter[bill]

boolean

Filtra lançamentos relacionados a contas a pagar

Example:

filter[guaranteedTransferIn][]

integer[]

Filtra lançamentos por IDs de transferência garantida

Example:

filter[haveTransfer][]

integer[]

Filtra lançamentos que possuem as transferências com os IDs especificados

Example:

filter[personIn][]

integer[]

Filtra lançamentos por IDs de pessoa

Example:

filter[tenantIn][]

integer[]

Filtra lançamentos por IDs de inquilino

Example:

filter[ownerIn][]

integer[]

Filtra lançamentos por IDs de proprietário

Example:

filter[ownerPlan]

boolean

Filtra lançamentos com plano de contas de proprietário

Example:

filter[brokerPlan]

boolean

Filtra lançamentos com plano de contas de corretor

Example:

filter[tenantPlan]

boolean

Filtra lançamentos com plano de contas de inquilino

Example:

filter[brokerIn][]

integer[]

Filtra lançamentos por IDs de corretor

Example:

filter[buildingIn][]

integer[]

Filtra lançamentos por IDs de imóvel

Example:

filter[accountIn][]

integer[]

Filtra lançamentos por IDs de conta financeira

Example:

filter[businessIn][]

integer[]

Filtra lançamentos por IDs de empresa

Example:

filter[businessAllowedIn][]

integer[]

Filtra lançamentos por IDs de empresas permitidas

Example:

filter[itemIn][]

integer[]

Filtra lançamentos por IDs de item

Example:

100

filter[status]

string

Filtra lançamentos por status (paid ou unpaid)

Example:

paid

filter[invoiceStatus]

string

Filtra lançamentos por status da fatura (paid, unpaid, overdue, in_protest, refunded, partially_paid, canceled ou uncollectible)

Example:

unpaid

filter[unpaid]

boolean

Filtra lançamentos não pagos

Example:

filter[paidOrGuaranteed]

boolean

Filtra lançamentos pagos ou com repasse garantido

Example:

filter[typeIn][]

integer[]

Filtra lançamentos por tipos (credit, debit, transfer)

filter[typeInvoiceIn][]

string[]

Filtra lançamentos por tipo de fatura (geralmente credit)

filter[modeIn][]

string[]

Filtra lançamentos por modos

filter[itemType][]

string[]

Filtra lançamentos por tipo de item

filter[contractTypeIn][]

string[]

Filtra lançamentos por tipo de contrato

filter[planIn][]

integer[]

Filtra lançamentos por IDs de plano de contas

Example:

filter[planAllIn][]

integer[]

Filtra lançamentos por IDs de plano de contas (incluindo pais)

Example:

filter[contractIn][]

integer[]

Filtra lançamentos por IDs de contrato

Example:

filter[contractIdIn][]

integer[]

Filtra lançamentos por IDs de contrato (id2)

Example:

filter[contractActiveIn][]

integer[]

Filtra lançamentos por status de atividade do contrato

filter[invoiceIn][]

integer[]

Filtra lançamentos por IDs de fatura

Example:

200

filter[isNotInvoice]

boolean

Filtra lançamentos que não são faturas

Example:

filter[invoiceIdIn][]

integer[]

Filtra lançamentos por IDs de fatura (id2)

filter[positionMin]

integer

Filtra lançamentos por posição mínima (timestamp + position)

Example:

1678886400

filter[positionMax]

integer

Filtra lançamentos por posição máxima (timestamp + position)

Example:

1678972800

filter[onlyAllowed]

boolean

Filtra lançamentos permitidos ao usuário logado

Example:

filter[billingMethodIn][]

string[]

Filtra lançamentos por métodos de cobrança. Valores comuns incluem pix, bank_transfer, etc.

filter[ticketRegister]

string

Filtra lançamentos por registro de ticket (registered ou unregistered)

Example:

registered

filter[onlyInvoice]

boolean

Filtra apenas lançamentos que são faturas

Example:

filter[itemListOwnerReport]

boolean

Filtra lançamentos para relatório do proprietário

Example:

filter[extractIn][]

string[]

Filtra lançamentos por extrato

filter[overdue]

boolean

Filtra lançamentos vencidos

Example:

filter[early]

boolean

Filtra lançamentos a vencer

Example:

filter[forBusiness]

boolean

Filtra lançamentos do extrato da empresa

Example:

filter[forOwner]

boolean

Filtra lançamentos do extrato do proprietário

Example:

filter[forBroker]

boolean

Filtra lançamentos do extrato do corretor

Example:

filter[forTenant]

boolean

Filtra lançamentos do extrato do inquilino

Example:

filter[forPayer]

boolean

Filtra lançamentos do extrato do pagador

Example:

filter[tagIn][]

integer[]

Filtra lançamentos por tags

Example:

filter[invoiceTypeIn]

boolean

Filtra lançamentos por tipo de fatura 'single'

Example:

filter[paidGuaranteedOrTransfer]

boolean

Filtra lançamentos pagos, garantidos ou de transferência

Example:

filter[billIdIn][]

integer[]

Filtra lançamentos por IDs de contas a pagar

Example:

300

filter[billPayment]

boolean

Filtra lançamentos relacionados a pagamentos de contas

Example:

filter[brokerCommission]

boolean

Filtra lançamentos de comissão do corretor logado

Example:

filter[invoicePaidIn]

string

Filtra lançamentos por status de pagamento da fatura (paid ou unpaid)

Example:

paid

include[item]

string

Retorna os dados do item da transação.

Example:

id,description

include[commissionItem]

string

Retorna os dados do item de comissão.

Example:

id,description

include[contract]

string

Retorna os dados do contrato.

Example:

id,number

include[owner]

string

Retorna os dados do proprietário.

Example:

id,name

include[person]

string

Retorna os dados da pessoa.

Example:

id,name

include[tenant]

string

Retorna os dados do inquilino.

Example:

id,name

include[building]

string

Retorna os dados do imóvel.

Example:

id,name

include[account]

string

Retorna os dados da conta financeira.

Example:

id,name

include[plan]

string

Retorna os dados do plano de contas.

Example:

id,name

include[invoice]

string

Retorna os dados da fatura.

Example:

id,number

include[files]

string

Retorna os anexos da transação.

Example:

id,name,file_name

include[tags]

string

Retorna as tags.

Example:

id,description

include[transferredBy]

string

Retorna as transações que geraram esta transferência.

Example:

id,amount

include[transferredItems]

string

Retorna os itens transferidos.

Example:

id,amount

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/transactions?sort=id&fields=id%2Ctype%2Ctotal&filter%5Bid%5D=1&filter%5Bcompany_id%5D=1&filter%5Bsplit%5D=50&filter%5Binvoice_id%5D=1&filter%5Btransfer_id%5D=1&filter%5Bmorph_key%5D=invoice&filter%5Bmode%5D=transaction&filter%5Btype%5D=debit&filter%5Baccount_id%5D=1&filter%5Bbusiness_id%5D=1&filter%5Bplan_id%5D=1&filter%5Buser_id%5D=1&filter%5Bitem_id%5D=1&filter%5Bguaranteed_transfer_id%5D=1&filter%5Bperson_id%5D=1&filter%5Bbuilding_id%5D=1&filter%5Bcontract_id%5D=1&filter%5Bbroker_id%5D=1&filter%5Bowner_id%5D=1&filter%5Btenant_id%5D=1&filter%5Bextract%5D=owner&filter%5Bdate%5D=2024-01-01&filter%5Bposition%5D=1&filter%5Bamount%5D=100.00&filter%5Bamount_primary%5D=100.00&filter%5Bpercentage%5D=10.00&filter%5Bcompetence%5D=2024-01-01&filter%5Bdescription%5D=Conta+de+Luz&filter%5Bpaid%5D=1&filter%5Bdue_date%5D=2024-01-10&filter%5Bbilling_method%5D=pix&filter%5BonlyVisible%5D=1&filter%5Btransfer%5D=1&filter%5BbrokerTransfer%5D=1&filter%5BautoTransfer%5D=1&filter%5BmanualTransfer%5D=1&filter%5Bbill%5D=1&filter%5BguaranteedTransferIn%5D%5B%5D=5&filter%5BhaveTransfer%5D%5B%5D=10&filter%5BpersonIn%5D%5B%5D=1&filter%5BtenantIn%5D%5B%5D=3&filter%5BownerIn%5D%5B%5D=5&filter%5BownerPlan%5D=1&filter%5BbrokerPlan%5D=1&filter%5BtenantPlan%5D=1&filter%5BbrokerIn%5D%5B%5D=7&filter%5BbuildingIn%5D%5B%5D=9&filter%5BaccountIn%5D%5B%5D=1&filter%5BbusinessIn%5D%5B%5D=1&filter%5BbusinessAllowedIn%5D%5B%5D=1&filter%5BitemIn%5D%5B%5D=100&filter%5Bstatus%5D=paid&filter%5BinvoiceStatus%5D=unpaid&filter%5Bunpaid%5D=1&filter%5BpaidOrGuaranteed%5D=1&filter%5BtypeIn%5D%5B%5D=&filter%5BtypeInvoiceIn%5D%5B%5D=&filter%5BmodeIn%5D%5B%5D=&filter%5BitemType%5D%5B%5D=&filter%5BcontractTypeIn%5D%5B%5D=&filter%5BplanIn%5D%5B%5D=10&filter%5BplanAllIn%5D%5B%5D=10&filter%5BcontractIn%5D%5B%5D=1&filter%5BcontractIdIn%5D%5B%5D=1&filter%5BcontractActiveIn%5D%5B%5D=&filter%5BinvoiceIn%5D%5B%5D=200&filter%5BisNotInvoice%5D=1&filter%5BinvoiceIdIn%5D%5B%5D=&filter%5BpositionMin%5D=1678886400&filter%5BpositionMax%5D=1678972800&filter%5BonlyAllowed%5D=1&filter%5BbillingMethodIn%5D%5B%5D=&filter%5BticketRegister%5D=registered&filter%5BonlyInvoice%5D=1&filter%5BitemListOwnerReport%5D=1&filter%5BextractIn%5D%5B%5D=&filter%5Boverdue%5D=1&filter%5Bearly%5D=1&filter%5BforBusiness%5D=1&filter%5BforOwner%5D=1&filter%5BforBroker%5D=1&filter%5BforTenant%5D=1&filter%5BforPayer%5D=1&filter%5BtagIn%5D%5B%5D=1&filter%5BinvoiceTypeIn%5D=1&filter%5BpaidGuaranteedOrTransfer%5D=1&filter%5BbillIdIn%5D%5B%5D=300&filter%5BbillPayment%5D=1&filter%5BbrokerCommission%5D=1&filter%5BinvoicePaidIn%5D=paid&include%5Bitem%5D=id%2Cdescription&include%5BcommissionItem%5D=id%2Cdescription&include%5Bcontract%5D=id%2Cnumber&include%5Bowner%5D=id%2Cname&include%5Bperson%5D=id%2Cname&include%5Btenant%5D=id%2Cname&include%5Bbuilding%5D=id%2Cname&include%5Baccount%5D=id%2Cname&include%5Bplan%5D=id%2Cname&include%5Binvoice%5D=id%2Cnumber&include%5Bfiles%5D=id%2Cname%2Cfile_name&include%5Btags%5D=id%2Cdescription&include%5BtransferredBy%5D=id%2Camount&include%5BtransferredItems%5D=id%2Camount" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.apresenta.me/transactions"
);

const params = {
    "sort": "id",
    "fields": "id,type,total",
    "filter[id]": "1",
    "filter[company_id]": "1",
    "filter[split]": "50",
    "filter[invoice_id]": "1",
    "filter[transfer_id]": "1",
    "filter[morph_key]": "invoice",
    "filter[mode]": "transaction",
    "filter[type]": "debit",
    "filter[account_id]": "1",
    "filter[business_id]": "1",
    "filter[plan_id]": "1",
    "filter[user_id]": "1",
    "filter[item_id]": "1",
    "filter[guaranteed_transfer_id]": "1",
    "filter[person_id]": "1",
    "filter[building_id]": "1",
    "filter[contract_id]": "1",
    "filter[broker_id]": "1",
    "filter[owner_id]": "1",
    "filter[tenant_id]": "1",
    "filter[extract]": "owner",
    "filter[date]": "2024-01-01",
    "filter[position]": "1",
    "filter[amount]": "100.00",
    "filter[amount_primary]": "100.00",
    "filter[percentage]": "10.00",
    "filter[competence]": "2024-01-01",
    "filter[description]": "Conta de Luz",
    "filter[paid]": "1",
    "filter[due_date]": "2024-01-10",
    "filter[billing_method]": "pix",
    "filter[onlyVisible]": "1",
    "filter[transfer]": "1",
    "filter[brokerTransfer]": "1",
    "filter[autoTransfer]": "1",
    "filter[manualTransfer]": "1",
    "filter[bill]": "1",
    "filter[guaranteedTransferIn][]": "5",
    "filter[haveTransfer][]": "10",
    "filter[personIn][]": "1",
    "filter[tenantIn][]": "3",
    "filter[ownerIn][]": "5",
    "filter[ownerPlan]": "1",
    "filter[brokerPlan]": "1",
    "filter[tenantPlan]": "1",
    "filter[brokerIn][]": "7",
    "filter[buildingIn][]": "9",
    "filter[accountIn][]": "1",
    "filter[businessIn][]": "1",
    "filter[businessAllowedIn][]": "1",
    "filter[itemIn][]": "100",
    "filter[status]": "paid",
    "filter[invoiceStatus]": "unpaid",
    "filter[unpaid]": "1",
    "filter[paidOrGuaranteed]": "1",
    "filter[typeIn][]": "",
    "filter[typeInvoiceIn][]": "",
    "filter[modeIn][]": "",
    "filter[itemType][]": "",
    "filter[contractTypeIn][]": "",
    "filter[planIn][]": "10",
    "filter[planAllIn][]": "10",
    "filter[contractIn][]": "1",
    "filter[contractIdIn][]": "1",
    "filter[contractActiveIn][]": "",
    "filter[invoiceIn][]": "200",
    "filter[isNotInvoice]": "1",
    "filter[invoiceIdIn][]": "",
    "filter[positionMin]": "1678886400",
    "filter[positionMax]": "1678972800",
    "filter[onlyAllowed]": "1",
    "filter[billingMethodIn][]": "",
    "filter[ticketRegister]": "registered",
    "filter[onlyInvoice]": "1",
    "filter[itemListOwnerReport]": "1",
    "filter[extractIn][]": "",
    "filter[overdue]": "1",
    "filter[early]": "1",
    "filter[forBusiness]": "1",
    "filter[forOwner]": "1",
    "filter[forBroker]": "1",
    "filter[forTenant]": "1",
    "filter[forPayer]": "1",
    "filter[tagIn][]": "1",
    "filter[invoiceTypeIn]": "1",
    "filter[paidGuaranteedOrTransfer]": "1",
    "filter[billIdIn][]": "300",
    "filter[billPayment]": "1",
    "filter[brokerCommission]": "1",
    "filter[invoicePaidIn]": "paid",
    "include[item]": "id,description",
    "include[commissionItem]": "id,description",
    "include[contract]": "id,number",
    "include[owner]": "id,name",
    "include[person]": "id,name",
    "include[tenant]": "id,name",
    "include[building]": "id,name",
    "include[account]": "id,name",
    "include[plan]": "id,name",
    "include[invoice]": "id,number",
    "include[files]": "id,name,file_name",
    "include[tags]": "id,description",
    "include[transferredBy]": "id,amount",
    "include[transferredItems]": "id,amount",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/transactions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'sort' => 'id',
            'fields' => 'id,type,total',
            'filter[id]' => '1',
            'filter[company_id]' => '1',
            'filter[split]' => '50',
            'filter[invoice_id]' => '1',
            'filter[transfer_id]' => '1',
            'filter[morph_key]' => 'invoice',
            'filter[mode]' => 'transaction',
            'filter[type]' => 'debit',
            'filter[account_id]' => '1',
            'filter[business_id]' => '1',
            'filter[plan_id]' => '1',
            'filter[user_id]' => '1',
            'filter[item_id]' => '1',
            'filter[guaranteed_transfer_id]' => '1',
            'filter[person_id]' => '1',
            'filter[building_id]' => '1',
            'filter[contract_id]' => '1',
            'filter[broker_id]' => '1',
            'filter[owner_id]' => '1',
            'filter[tenant_id]' => '1',
            'filter[extract]' => 'owner',
            'filter[date]' => '2024-01-01',
            'filter[position]' => '1',
            'filter[amount]' => '100.00',
            'filter[amount_primary]' => '100.00',
            'filter[percentage]' => '10.00',
            'filter[competence]' => '2024-01-01',
            'filter[description]' => 'Conta de Luz',
            'filter[paid]' => '1',
            'filter[due_date]' => '2024-01-10',
            'filter[billing_method]' => 'pix',
            'filter[onlyVisible]' => '1',
            'filter[transfer]' => '1',
            'filter[brokerTransfer]' => '1',
            'filter[autoTransfer]' => '1',
            'filter[manualTransfer]' => '1',
            'filter[bill]' => '1',
            'filter[guaranteedTransferIn][]' => '5',
            'filter[haveTransfer][]' => '10',
            'filter[personIn][]' => '1',
            'filter[tenantIn][]' => '3',
            'filter[ownerIn][]' => '5',
            'filter[ownerPlan]' => '1',
            'filter[brokerPlan]' => '1',
            'filter[tenantPlan]' => '1',
            'filter[brokerIn][]' => '7',
            'filter[buildingIn][]' => '9',
            'filter[accountIn][]' => '1',
            'filter[businessIn][]' => '1',
            'filter[businessAllowedIn][]' => '1',
            'filter[itemIn][]' => '100',
            'filter[status]' => 'paid',
            'filter[invoiceStatus]' => 'unpaid',
            'filter[unpaid]' => '1',
            'filter[paidOrGuaranteed]' => '1',
            'filter[typeIn][]' => '',
            'filter[typeInvoiceIn][]' => '',
            'filter[modeIn][]' => '',
            'filter[itemType][]' => '',
            'filter[contractTypeIn][]' => '',
            'filter[planIn][]' => '10',
            'filter[planAllIn][]' => '10',
            'filter[contractIn][]' => '1',
            'filter[contractIdIn][]' => '1',
            'filter[contractActiveIn][]' => '',
            'filter[invoiceIn][]' => '200',
            'filter[isNotInvoice]' => '1',
            'filter[invoiceIdIn][]' => '',
            'filter[positionMin]' => '1678886400',
            'filter[positionMax]' => '1678972800',
            'filter[onlyAllowed]' => '1',
            'filter[billingMethodIn][]' => '',
            'filter[ticketRegister]' => 'registered',
            'filter[onlyInvoice]' => '1',
            'filter[itemListOwnerReport]' => '1',
            'filter[extractIn][]' => '',
            'filter[overdue]' => '1',
            'filter[early]' => '1',
            'filter[forBusiness]' => '1',
            'filter[forOwner]' => '1',
            'filter[forBroker]' => '1',
            'filter[forTenant]' => '1',
            'filter[forPayer]' => '1',
            'filter[tagIn][]' => '1',
            'filter[invoiceTypeIn]' => '1',
            'filter[paidGuaranteedOrTransfer]' => '1',
            'filter[billIdIn][]' => '300',
            'filter[billPayment]' => '1',
            'filter[brokerCommission]' => '1',
            'filter[invoicePaidIn]' => 'paid',
            'include[item]' => 'id,description',
            'include[commissionItem]' => 'id,description',
            'include[contract]' => 'id,number',
            'include[owner]' => 'id,name',
            'include[person]' => 'id,name',
            'include[tenant]' => 'id,name',
            'include[building]' => 'id,name',
            'include[account]' => 'id,name',
            'include[plan]' => 'id,name',
            'include[invoice]' => 'id,number',
            'include[files]' => 'id,name,file_name',
            'include[tags]' => 'id,description',
            'include[transferredBy]' => 'id,amount',
            'include[transferredItems]' => 'id,amount',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.apresenta.me/transactions'
params = {
  'sort': 'id',
  'fields': 'id,type,total',
  'filter[id]': '1',
  'filter[company_id]': '1',
  'filter[split]': '50',
  'filter[invoice_id]': '1',
  'filter[transfer_id]': '1',
  'filter[morph_key]': 'invoice',
  'filter[mode]': 'transaction',
  'filter[type]': 'debit',
  'filter[account_id]': '1',
  'filter[business_id]': '1',
  'filter[plan_id]': '1',
  'filter[user_id]': '1',
  'filter[item_id]': '1',
  'filter[guaranteed_transfer_id]': '1',
  'filter[person_id]': '1',
  'filter[building_id]': '1',
  'filter[contract_id]': '1',
  'filter[broker_id]': '1',
  'filter[owner_id]': '1',
  'filter[tenant_id]': '1',
  'filter[extract]': 'owner',
  'filter[date]': '2024-01-01',
  'filter[position]': '1',
  'filter[amount]': '100.00',
  'filter[amount_primary]': '100.00',
  'filter[percentage]': '10.00',
  'filter[competence]': '2024-01-01',
  'filter[description]': 'Conta de Luz',
  'filter[paid]': '1',
  'filter[due_date]': '2024-01-10',
  'filter[billing_method]': 'pix',
  'filter[onlyVisible]': '1',
  'filter[transfer]': '1',
  'filter[brokerTransfer]': '1',
  'filter[autoTransfer]': '1',
  'filter[manualTransfer]': '1',
  'filter[bill]': '1',
  'filter[guaranteedTransferIn][]': '5',
  'filter[haveTransfer][]': '10',
  'filter[personIn][]': '1',
  'filter[tenantIn][]': '3',
  'filter[ownerIn][]': '5',
  'filter[ownerPlan]': '1',
  'filter[brokerPlan]': '1',
  'filter[tenantPlan]': '1',
  'filter[brokerIn][]': '7',
  'filter[buildingIn][]': '9',
  'filter[accountIn][]': '1',
  'filter[businessIn][]': '1',
  'filter[businessAllowedIn][]': '1',
  'filter[itemIn][]': '100',
  'filter[status]': 'paid',
  'filter[invoiceStatus]': 'unpaid',
  'filter[unpaid]': '1',
  'filter[paidOrGuaranteed]': '1',
  'filter[typeIn][]': '',
  'filter[typeInvoiceIn][]': '',
  'filter[modeIn][]': '',
  'filter[itemType][]': '',
  'filter[contractTypeIn][]': '',
  'filter[planIn][]': '10',
  'filter[planAllIn][]': '10',
  'filter[contractIn][]': '1',
  'filter[contractIdIn][]': '1',
  'filter[contractActiveIn][]': '',
  'filter[invoiceIn][]': '200',
  'filter[isNotInvoice]': '1',
  'filter[invoiceIdIn][]': '',
  'filter[positionMin]': '1678886400',
  'filter[positionMax]': '1678972800',
  'filter[onlyAllowed]': '1',
  'filter[billingMethodIn][]': '',
  'filter[ticketRegister]': 'registered',
  'filter[onlyInvoice]': '1',
  'filter[itemListOwnerReport]': '1',
  'filter[extractIn][]': '',
  'filter[overdue]': '1',
  'filter[early]': '1',
  'filter[forBusiness]': '1',
  'filter[forOwner]': '1',
  'filter[forBroker]': '1',
  'filter[forTenant]': '1',
  'filter[forPayer]': '1',
  'filter[tagIn][]': '1',
  'filter[invoiceTypeIn]': '1',
  'filter[paidGuaranteedOrTransfer]': '1',
  'filter[billIdIn][]': '300',
  'filter[billPayment]': '1',
  'filter[brokerCommission]': '1',
  'filter[invoicePaidIn]': 'paid',
  'include[item]': 'id,description',
  'include[commissionItem]': 'id,description',
  'include[contract]': 'id,number',
  'include[owner]': 'id,name',
  'include[person]': 'id,name',
  'include[tenant]': 'id,name',
  'include[building]': 'id,name',
  'include[account]': 'id,name',
  'include[plan]': 'id,name',
  'include[invoice]': 'id,number',
  'include[files]': 'id,name,file_name',
  'include[tags]': 'id,description',
  'include[transferredBy]': 'id,amount',
  'include[transferredItems]': 'id,amount',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/transactions

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

description

string

required

Descrição do lançamento

Example:

Pagamento de aluguel

amount

number

required

Valor do lançamento

Example:

1500

amount_primary

number

required

Valor original do lançamento

Example:

1500

date

required

Data do lançamento

Example:

2024-03-20

type

string

required

Tipo do lançamento. Valores permitidos:

debit: Despesa
credit: Crédito
transfer: Transferência

Example:

credit

mode

string

required

Modo do lançamento. Valores permitidos:

transaction: Lançamentos
invoice: Faturas
transfer: Repasses
commission: Comissões
transfer_commission: Repasses de Comissões
guaranteed_rent: Aluguel Garantido
chargeback: Estornos

Example:

transaction

plan_id

integer

required

Plano de contas

Example:

business_id

integer

required

Empresa

Example:

account_id

integer

required

Conta financeira

Example:

person_id

integer

Pessoa relacionada

Example:

building_id

integer

Imóvel relacionado

Example:

contract_id

integer

Contrato relacionado

Example:

owner_id

integer

Proprietário relacionado

Example:

tenant_id

integer

Inquilino relacionado

Example:

broker_id

integer

Corretor relacionado

Example:

item_id

integer

Item da transação

Example:

invoice_id

integer

Fatura relacionada

Example:

tag

string[]

Tags relacionadas

Example:

[1,2]

notes

string

Observações

Example:

Observação importante

paid

boolean

Pago. Pode ser true (Pago) ou false (Agendado/Não Pago).

Example:

due_date

date

Data de vencimento

Example:

2024-03-20

billing_method

string

required

Método de cobrança Valores permitidos:

ticket: Boleto
cash: Dinheiro
deposit: Depósito
pix: PIX
ted: DOC/TED
credit: Cartão de Crédito
debit: Cartão de Débito
check: Cheque
debit_account: Débito em Conta

Example:

pix

interest

number

Juros

Example:

discount

number

Desconto

Example:

check_agency

string

Agência do cheque

Example:

1234

check_account

string

Conta do cheque

Example:

12345-6

check_id

string

Número do cheque

Example:

123456

recurrency_periodicity

string

Periodicidade da recorrência. Valores permitidos:

daily: Diariamente
weekly: Semanalmente
monthly: Mensalmente
bimonthly: Bimestralmente
quarterly: Trimestralmente
semiannually: Semestralmente
annually: Anualmente

Example:

monthly

recurrency_total

integer

Total de recorrências

Example:

recurrency_installment

integer

Parcela atual

Example:

commission

boolean

Comissão

Example:

commission_mode

string

Modo da comissão. Valores permitidos:

fixed: Valor Fixo
percentage: Porcentagem

Example:

fixed

commission_fixed

number

Valor fixo da comissão

Example:

100

commission_percentage

number

Percentual da comissão

Example:

commission_item_id

integer

Item da comissão

Example:

commission_id

integer

Comissão relacionada

Example:

metadata

json

Metadados

Example:

{"key": "value"}

Auth

Bearer

Headers

Body

{ "description": "Pagamento de aluguel", "amount": 1500, "amount_primary": 1500, "date": "2024-03-20", "type": "credit", "mode": "transaction", "plan_id": 11, "business_id": 6, "account_id": 1, "person_id": 1, "building_id": 1, "contract_id": 1, "owner_id": 1, "tenant_id": 1, "broker_id": 1, "item_id": 1, "invoice_id": 1, "tag": [ 1, 2 ], "notes": "Observa\u00e7\u00e3o importante", "paid": true, "due_date": "2024-03-20", "billing_method": "pix", "interest": 10, "discount": 10, "check_agency": "1234", "check_account": "12345-6", "check_id": "123456", "recurrency_periodicity": "monthly", "recurrency_total": 12, "recurrency_installment": 1, "commission": true, "commission_mode": "fixed", "commission_fixed": 100, "commission_percentage": 10, "commission_item_id": 1, "commission_id": 1, "metadata": "{\"key\": \"value\"}" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/transactions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Pagamento de aluguel\",
    \"amount\": 1500,
    \"amount_primary\": 1500,
    \"date\": \"2024-03-20\",
    \"type\": \"credit\",
    \"mode\": \"transaction\",
    \"plan_id\": 11,
    \"business_id\": 6,
    \"account_id\": 1,
    \"person_id\": 1,
    \"building_id\": 1,
    \"contract_id\": 1,
    \"owner_id\": 1,
    \"tenant_id\": 1,
    \"broker_id\": 1,
    \"item_id\": 1,
    \"invoice_id\": 1,
    \"tag\": [
        1,
        2
    ],
    \"notes\": \"Observação importante\",
    \"paid\": true,
    \"due_date\": \"2024-03-20\",
    \"billing_method\": \"pix\",
    \"interest\": 10,
    \"discount\": 10,
    \"check_agency\": \"1234\",
    \"check_account\": \"12345-6\",
    \"check_id\": \"123456\",
    \"recurrency_periodicity\": \"monthly\",
    \"recurrency_total\": 12,
    \"recurrency_installment\": 1,
    \"commission\": true,
    \"commission_mode\": \"fixed\",
    \"commission_fixed\": 100,
    \"commission_percentage\": 10,
    \"commission_item_id\": 1,
    \"commission_id\": 1,
    \"metadata\": \"{\\\"key\\\": \\\"value\\\"}\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/transactions';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'description' => 'Pagamento de aluguel',
            'amount' => 1500.0,
            'amount_primary' => 1500.0,
            'date' => '2024-03-20',
            'type' => 'credit',
            'mode' => 'transaction',
            'plan_id' => 11,
            'business_id' => 6,
            'account_id' => 1,
            'person_id' => 1,
            'building_id' => 1,
            'contract_id' => 1,
            'owner_id' => 1,
            'tenant_id' => 1,
            'broker_id' => 1,
            'item_id' => 1,
            'invoice_id' => 1,
            'tag' => [
                1,
                2,
            ],
            'notes' => 'Observação importante',
            'paid' => true,
            'due_date' => '2024-03-20',
            'billing_method' => 'pix',
            'interest' => 10.0,
            'discount' => 10.0,
            'check_agency' => '1234',
            'check_account' => '12345-6',
            'check_id' => '123456',
            'recurrency_periodicity' => 'monthly',
            'recurrency_total' => 12,
            'recurrency_installment' => 1,
            'commission' => true,
            'commission_mode' => 'fixed',
            'commission_fixed' => 100.0,
            'commission_percentage' => 10.0,
            'commission_item_id' => 1,
            'commission_id' => 1,
            'metadata' => '{"key": "value"}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Obter

GET

https://api.apresenta.me/transactions/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do lançamento

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,type,total

include[item]

string

Retorna os dados do item da transação.

Example:

id,description

include[commissionItem]

string

Retorna os dados do item de comissão.

Example:

id,description

include[contract]

string

Retorna os dados do contrato.

Example:

id,number

include[owner]

string

Retorna os dados do proprietário.

Example:

id,name

include[person]

string

Retorna os dados da pessoa.

Example:

id,name

include[tenant]

string

Retorna os dados do inquilino.

Example:

id,name

include[building]

string

Retorna os dados do imóvel.

Example:

id,name

include[account]

string

Retorna os dados da conta financeira.

Example:

id,name

include[plan]

string

Retorna os dados do plano de contas.

Example:

id,name

include[invoice]

string

Retorna os dados da fatura.

Example:

id,number

include[files]

string

Retorna os anexos da transação.

Example:

id,name,file_name

include[tags]

string

Retorna as tags.

Example:

id,description

include[transferredBy]

string

Retorna as transações que geraram esta transferência.

Example:

id,amount

include[transferredItems]

string

Retorna os itens transferidos.

Example:

id,amount

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/transactions/19?sort=id&fields=id%2Ctype%2Ctotal&include%5Bitem%5D=id%2Cdescription&include%5BcommissionItem%5D=id%2Cdescription&include%5Bcontract%5D=id%2Cnumber&include%5Bowner%5D=id%2Cname&include%5Bperson%5D=id%2Cname&include%5Btenant%5D=id%2Cname&include%5Bbuilding%5D=id%2Cname&include%5Baccount%5D=id%2Cname&include%5Bplan%5D=id%2Cname&include%5Binvoice%5D=id%2Cnumber&include%5Bfiles%5D=id%2Cname%2Cfile_name&include%5Btags%5D=id%2Cdescription&include%5BtransferredBy%5D=id%2Camount&include%5BtransferredItems%5D=id%2Camount" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/transactions/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Lançamento

Example:

Body Parameters

description

string

Descrição do lançamento

Example:

Pagamento de aluguel

amount

number

Valor do lançamento

Example:

1500

amount_primary

number

Valor original do lançamento

Example:

1500

date

Data do lançamento

Example:

2024-03-20

type

string

Tipo do lançamento. Valores permitidos:

debit: Despesa
credit: Crédito
transfer: Transferência

Example:

credit

mode

string

Modo do lançamento. Valores permitidos:

transaction: Lançamentos
invoice: Faturas
transfer: Repasses
commission: Comissões
transfer_commission: Repasses de Comissões
guaranteed_rent: Aluguel Garantido
chargeback: Estornos

Example:

transaction

plan_id

integer

Plano de contas

Example:

business_id

integer

Empresa

Example:

account_id

integer

Conta financeira

Example:

person_id

integer

Pessoa relacionada

Example:

building_id

integer

Imóvel relacionado

Example:

contract_id

integer

Contrato relacionado

Example:

owner_id

integer

Proprietário relacionado

Example:

tenant_id

integer

Inquilino relacionado

Example:

broker_id

integer

Corretor relacionado

Example:

item_id

integer

Item da transação

Example:

invoice_id

integer

Fatura relacionada

Example:

tag

string[]

Tags relacionadas

Example:

[1,2]

notes

string

Observações

Example:

Observação importante

paid

boolean

Pago. Pode ser true (Pago) ou false (Agendado/Não Pago).

Example:

due_date

date

Data de vencimento

Example:

2024-03-20

billing_method

string

required

Método de cobrança Valores permitidos:

ticket: Boleto
cash: Dinheiro
deposit: Depósito
pix: PIX
ted: DOC/TED
credit: Cartão de Crédito
debit: Cartão de Débito
check: Cheque
debit_account: Débito em Conta

Example:

pix

interest

number

Juros

Example:

discount

number

Desconto

Example:

check_agency

string

Agência do cheque

Example:

1234

check_account

string

Conta do cheque

Example:

12345-6

check_id

string

Número do cheque

Example:

123456

recurrency_periodicity

string

Periodicidade da recorrência. Valores permitidos:

daily: Diariamente
weekly: Semanalmente
monthly: Mensalmente
bimonthly: Bimestralmente
quarterly: Trimestralmente
semiannually: Semestralmente
annually: Anualmente

Example:

monthly

recurrency_total

integer

Total de recorrências

Example:

recurrency_installment

integer

Parcela atual

Example:

commission

boolean

Comissão

Example:

commission_mode

string

Modo da comissão. Valores permitidos:

fixed: Valor Fixo
percentage: Porcentagem

Example:

fixed

commission_fixed

number

Valor fixo da comissão

Example:

100

commission_percentage

number

Percentual da comissão

Example:

commission_item_id

integer

Item da comissão

Example:

commission_id

integer

Comissão relacionada

Example:

metadata

json

Metadados

Example:

{"key": "value"}

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/transactions/7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Pagamento de aluguel\",
    \"amount\": 1500,
    \"amount_primary\": 1500,
    \"date\": \"2024-03-20\",
    \"type\": \"credit\",
    \"mode\": \"transaction\",
    \"plan_id\": 11,
    \"business_id\": 6,
    \"account_id\": 1,
    \"person_id\": 1,
    \"building_id\": 1,
    \"contract_id\": 1,
    \"owner_id\": 1,
    \"tenant_id\": 1,
    \"broker_id\": 1,
    \"item_id\": 1,
    \"invoice_id\": 1,
    \"tag\": [
        1,
        2
    ],
    \"notes\": \"Observação importante\",
    \"paid\": true,
    \"due_date\": \"2024-03-20\",
    \"billing_method\": \"pix\",
    \"interest\": 10,
    \"discount\": 10,
    \"check_agency\": \"1234\",
    \"check_account\": \"12345-6\",
    \"check_id\": \"123456\",
    \"recurrency_periodicity\": \"monthly\",
    \"recurrency_total\": 12,
    \"recurrency_installment\": 1,
    \"commission\": true,
    \"commission_mode\": \"fixed\",
    \"commission_fixed\": 100,
    \"commission_percentage\": 10,
    \"commission_item_id\": 1,
    \"commission_id\": 1,
    \"metadata\": \"{\\\"key\\\": \\\"value\\\"}\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/transactions/7';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'description' => 'Pagamento de aluguel',
            'amount' => 1500.0,
            'amount_primary' => 1500.0,
            'date' => '2024-03-20',
            'type' => 'credit',
            'mode' => 'transaction',
            'plan_id' => 11,
            'business_id' => 6,
            'account_id' => 1,
            'person_id' => 1,
            'building_id' => 1,
            'contract_id' => 1,
            'owner_id' => 1,
            'tenant_id' => 1,
            'broker_id' => 1,
            'item_id' => 1,
            'invoice_id' => 1,
            'tag' => [
                1,
                2,
            ],
            'notes' => 'Observação importante',
            'paid' => true,
            'due_date' => '2024-03-20',
            'billing_method' => 'pix',
            'interest' => 10.0,
            'discount' => 10.0,
            'check_agency' => '1234',
            'check_account' => '12345-6',
            'check_id' => '123456',
            'recurrency_periodicity' => 'monthly',
            'recurrency_total' => 12,
            'recurrency_installment' => 1,
            'commission' => true,
            'commission_mode' => 'fixed',
            'commission_fixed' => 100.0,
            'commission_percentage' => 10.0,
            'commission_item_id' => 1,
            'commission_id' => 1,
            'metadata' => '{"key": "value"}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Excluir

DELETE

https://api.apresenta.me/transactions/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Lançamento

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/transactions/6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Repasses

Gerar link para Recibo de Repasse

GET

https://api.apresenta.me/transactions/{transaction_id}/receiptLink

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

transaction_id

integer

required

ID do Lançamento

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/transactions/8/receiptLink" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Itens para Lançamentos

Pesquisar

GET

https://api.apresenta.me/financial/transactionItems

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description,debit,credit,active

filter[description]

string

Filtra por descrição do Item

Example:

Aluguel

filter[debit]

string

Filtra por tipo de débito. Valores permitidos:

business: Imobiliária/Empresa
owner: Proprietário
customer: Cliente
broker: Corretor/Vendedor

Example:

owner

filter[credit]

string

Filtra por tipo de crédito. Valores permitidos:

business: Imobiliária/Empresa
owner: Proprietário
customer: Cliente
broker: Corretor/Vendedor

Example:

customer

filter[type]

string

Filtra por tipo do Item. Valores permitidos:

default: Padrão
commission: Comissão
single_commission: Comissão Avulsa
rent: Aluguel
tariff: Tarifa
fee: Multa/Juros
discount: Desconto
duty: Imposto Retido
iptu: IPTU

Example:

default

filter[purpose]

string

Filtra por finalidade do Item. Valores permitidos:

rent: Locação
sale: Venda
subscription: Assinatura

Example:

rent

filter[active]

boolean

Filtra por status do Item

Example:

filter[guaranteed_transfer]

boolean

Filtra por transferência garantida

Example:

filter[owner_report]

boolean

Filtra por relatório do proprietário

Example:

filter[readjust]

boolean

Filtra por reajuste

Example:

filter[fiscal_note]

boolean

Filtra por nota fiscal

Example:

filter[dimob]

boolean

Filtra por DIMOB

Example:

filter[blocked]

boolean

Filtra por bloqueado

Example:

filter[typeIn][]

string[]

Filtra por tipos de item

filter[debitIn][]

string[]

Filtra por tipos de débito

filter[creditIn][]

string[]

Filtra por tipos de crédito

filter[withReadjust]

boolean

Filtra por reajuste

Example:

filter[generatesFiscalNote]

boolean

Filtra por geração de nota fiscal

Example:

filter[onlyRent]

boolean

Filtra por itens de locação

Example:

filter[onlySale]

boolean

Filtra por itens de venda

Example:

filter[purposeIn][]

string[]

Filtra por finalidades

filter[involvedIn][]

string[]

Filtra por envolvidos

include[debitPlan]

string

Incluir dados do Plano de Contas de Débito

Example:

id,name,code

include[creditPlan]

string

Incluir dados do Plano de Contas de Crédito

Example:

id,name,code

include[transactions]

string

Incluir dados das Transações

Example:

id,value,date

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/financial/transactionItems?sort=id&fields=id%2Cdescription%2Cdebit%2Ccredit%2Cactive&filter%5Bdescription%5D=Aluguel&filter%5Bdebit%5D=owner&filter%5Bcredit%5D=customer&filter%5Btype%5D=default&filter%5Bpurpose%5D=rent&filter%5Bactive%5D=1&filter%5Bguaranteed_transfer%5D=1&filter%5Bowner_report%5D=1&filter%5Breadjust%5D=1&filter%5Bfiscal_note%5D=1&filter%5Bdimob%5D=1&filter%5Bblocked%5D=1&filter%5BtypeIn%5D%5B%5D=&filter%5BdebitIn%5D%5B%5D=&filter%5BcreditIn%5D%5B%5D=&filter%5BwithReadjust%5D=1&filter%5BgeneratesFiscalNote%5D=1&filter%5BonlyRent%5D=1&filter%5BonlySale%5D=1&filter%5BpurposeIn%5D%5B%5D=&filter%5BinvolvedIn%5D%5B%5D=&include%5BdebitPlan%5D=id%2Cname%2Ccode&include%5BcreditPlan%5D=id%2Cname%2Ccode&include%5Btransactions%5D=id%2Cvalue%2Cdate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/financial/transactionItems

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

description

string

required

Descrição do Item

Example:

Aluguel

debit

string

required

Tipo de débito. Valores permitidos:

business: Imobiliária/Empresa
owner: Proprietário
customer: Cliente
broker: Corretor/Vendedor

Example:

owner

credit

string

required

Tipo de crédito. Valores permitidos:

business: Imobiliária/Empresa
owner: Proprietário
customer: Cliente
broker: Corretor/Vendedor

Example:

customer

type

string

Tipo do Item. Valores permitidos:

default: Padrão
commission: Comissão
single_commission: Comissão Avulsa
rent: Aluguel
tariff: Tarifa
fee: Multa/Juros
discount: Desconto
duty: Imposto Retido
iptu: IPTU

Example:

default

purpose

string

Finalidade do Item. (Pode ser um array de strings se múltiplas finalidades forem permitidas pela lógica de negócios, ajuste o tipo se necessário) Valores permitidos:

rent: Locação
sale: Venda
subscription: Assinatura

Example:

rent

active

boolean

Status do Item

Example:

guaranteed_transfer

boolean

Transferência garantida

Example:

owner_report

boolean

Relatório do proprietário

Example:

readjust

boolean

Reajuste

Example:

fiscal_note

boolean

Nota fiscal

Example:

dimob

boolean

DIMOB

Example:

blocked

boolean

Bloqueado

Example:

Auth

Bearer

Headers

Body

{ "description": "Aluguel", "debit": "owner", "credit": "customer", "type": "default", "purpose": "rent", "active": true, "guaranteed_transfer": true, "owner_report": true, "readjust": true, "fiscal_note": true, "dimob": true, "blocked": true }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/financial/transactionItems" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Aluguel\",
    \"debit\": \"owner\",
    \"credit\": \"customer\",
    \"type\": \"default\",
    \"purpose\": \"rent\",
    \"active\": true,
    \"guaranteed_transfer\": true,
    \"owner_report\": true,
    \"readjust\": true,
    \"fiscal_note\": true,
    \"dimob\": true,
    \"blocked\": true
}"

Obter

GET

https://api.apresenta.me/financial/transactionItems/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Item

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description,debit,credit,active

include[debitPlan]

string

Incluir dados do Plano de Contas de Débito

Example:

id,name,code

include[creditPlan]

string

Incluir dados do Plano de Contas de Crédito

Example:

id,name,code

include[transactions]

string

Incluir dados das Transações

Example:

id,value,date

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/financial/transactionItems/6?sort=id&fields=id%2Cdescription%2Cdebit%2Ccredit%2Cactive&include%5BdebitPlan%5D=id%2Cname%2Ccode&include%5BcreditPlan%5D=id%2Cname%2Ccode&include%5Btransactions%5D=id%2Cvalue%2Cdate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/financial/transactionItems/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Item

Example:

Body Parameters

description

string

Descrição do Item

Example:

Aluguel

debit

string

Tipo de débito. Valores permitidos:

business: Imobiliária/Empresa
owner: Proprietário
customer: Cliente
broker: Corretor/Vendedor

Example:

owner

credit

string

Tipo de crédito. Valores permitidos:

business: Imobiliária/Empresa
owner: Proprietário
customer: Cliente
broker: Corretor/Vendedor

Example:

customer

type

string

Tipo do Item. Valores permitidos:

default: Padrão
commission: Comissão
single_commission: Comissão Avulsa
rent: Aluguel
tariff: Tarifa
fee: Multa/Juros
discount: Desconto
duty: Imposto Retido
iptu: IPTU

Example:

default

purpose

string

Finalidade do Item. (Pode ser um array de strings se múltiplas finalidades forem permitidas pela lógica de negócios, ajuste o tipo se necessário) Valores permitidos:

rent: Locação
sale: Venda
subscription: Assinatura

Example:

rent

active

boolean

Status do Item

Example:

guaranteed_transfer

boolean

Transferência garantida

Example:

owner_report

boolean

Relatório do proprietário

Example:

readjust

boolean

Reajuste

Example:

fiscal_note

boolean

Nota fiscal

Example:

dimob

boolean

DIMOB

Example:

blocked

boolean

Bloqueado

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/financial/transactionItems/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Aluguel\",
    \"debit\": \"owner\",
    \"credit\": \"customer\",
    \"type\": \"default\",
    \"purpose\": \"rent\",
    \"active\": true,
    \"guaranteed_transfer\": true,
    \"owner_report\": true,
    \"readjust\": true,
    \"fiscal_note\": true,
    \"dimob\": true,
    \"blocked\": true
}"

Excluir

DELETE

https://api.apresenta.me/financial/transactionItems/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Item

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/financial/transactionItems/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Contratos » Veículos

Pesquisar

GET

https://api.apresenta.me/financial/contracts/{contract_id}/vehicles

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

Id do Contrato

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,brand,model,plate

filter[brand]

string

Filtra por marca do veículo

Example:

Fiat

filter[model]

string

Filtra por modelo do veículo

Example:

Uno

filter[color]

string

Filtra por cor do veículo

Example:

Prata

filter[plate]

string

Filtra por placa do veículo

Example:

ABC1234

include[contract]

string

Incluir dados do Contrato

Example:

id,reference,type

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/financial/contracts/1/vehicles?sort=id&fields=id%2Cbrand%2Cmodel%2Cplate&filter%5Bbrand%5D=Fiat&filter%5Bmodel%5D=Uno&filter%5Bcolor%5D=Prata&filter%5Bplate%5D=ABC1234&include%5Bcontract%5D=id%2Creference%2Ctype" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/financial/contracts/{contract_id}/vehicles

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

required

Id do Contrato

Example:

Body Parameters

brand

string

required

Marca do veículo

Example:

Fiat

model

string

required

Modelo do veículo

Example:

Uno

color

string

Cor do veículo

Example:

Prata

plate

string

Placa do veículo

Example:

ABC1234

Auth

Bearer

Headers

URL Parameters

Body

{ "brand": "Fiat", "model": "Uno", "color": "Prata", "plate": "ABC1234" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/financial/contracts/9/vehicles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"brand\": \"Fiat\",
    \"model\": \"Uno\",
    \"color\": \"Prata\",
    \"plate\": \"ABC1234\"
}"

Obter

GET

https://api.apresenta.me/financial/contracts/{contract_id}/vehicles/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

Id do Contrato

Example:

integer

required

Id do Veículo

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,brand,model,plate

include[contract]

string

Incluir dados do Contrato

Example:

id,reference,type

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/financial/contracts/2/vehicles/3?sort=id&fields=id%2Cbrand%2Cmodel%2Cplate&include%5Bcontract%5D=id%2Creference%2Ctype" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/financial/contracts/{contract_id}/vehicles/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

Id do Contrato

Example:

integer

required

Id do Veículo

Example:

Body Parameters

brand

string

Marca do veículo

Example:

Fiat

model

string

Modelo do veículo

Example:

Uno

color

string

Cor do veículo

Example:

Prata

plate

string

Placa do veículo

Example:

ABC1234

Auth

Bearer

Headers

URL Parameters

Body

{ "brand": "Fiat", "model": "Uno", "color": "Prata", "plate": "ABC1234" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/financial/contracts/15/vehicles/18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"brand\": \"Fiat\",
    \"model\": \"Uno\",
    \"color\": \"Prata\",
    \"plate\": \"ABC1234\"
}"

Excluir

DELETE

https://api.apresenta.me/financial/contracts/{contract_id}/vehicles/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

Id do Contrato

Example:

integer

required

Id do Veículo

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/financial/contracts/1/vehicles/9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Contratos » Ocupantes

Pesquisar

GET

https://api.apresenta.me/financial/contracts/{contract_id}/occupants

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

Id do Contrato

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,type,principal

filter[name]

string

Filtra por nome do Ocupante

Example:

Jorge

filter[type]

string

Filtra por tipo do Ocupante. Valores permitidos:

resident: Morador
tenant: Inquilino
guarantor: Fiador
witness: Testemunha
payer: Responsável pelo Pagamento
buyer: Comprador
procurator: Procurador

Example:

resident

filter[principal]

boolean

Filtra por ocupante principal

Example:

filter[start_at]

string

date Filtra por data de entrada

Example:

2024-01-01

filter[end_at]

string

date Filtra por data de saída

Example:

2024-12-31

filter[typeIn][]

string[]

Filtra por tipos de ocupante

include[person]

string

Incluir dados da Pessoa

Example:

id,name,tax_id

include[contract]

string

Incluir dados do Contrato

Example:

id,reference,type

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/financial/contracts/11/occupants?sort=id&fields=id%2Cname%2Ctype%2Cprincipal&filter%5Bname%5D=Jorge&filter%5Btype%5D=resident&filter%5Bprincipal%5D=1&filter%5Bstart_at%5D=2024-01-01&filter%5Bend_at%5D=2024-12-31&filter%5BtypeIn%5D%5B%5D=&include%5Bperson%5D=id%2Cname%2Ctax_id&include%5Bcontract%5D=id%2Creference%2Ctype" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/financial/contracts/{contract_id}/occupants

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

required

Id do Contrato

Example:

Body Parameters

type

string

required

Tipo do ocupante. Valores permitidos:

resident: Morador
tenant: Inquilino
guarantor: Fiador
witness: Testemunha
payer: Responsável pelo Pagamento
buyer: Comprador
procurator: Procurador

Example:

resident

name

string

required

Nome do ocupante

Example:

Jorge

person_id

integer

ID da pessoa

Example:

123456

tax_id

string

CPF/CNPJ

Example:

123.456.789-00

principal

boolean

Ocupante principal

percentage

number

Porcentagem

Example:

100

start_at

date

Data de entrada

Example:

2024-01-01

end_at

date

Data de saída

Example:

2024-12-31

description

string

Descrição

Example:

Morador principal

notes

string

Observações

Example:

Observações importantes

Auth

Bearer

Headers

URL Parameters

Body

{ "type": "resident", "name": "Jorge", "person_id": 123456, "tax_id": "123.456.789-00", "principal": false, "percentage": 100, "start_at": "2024-01-01", "end_at": "2024-12-31", "description": "Morador principal", "notes": "Observa\u00e7\u00f5es importantes" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/financial/contracts/2/occupants" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"resident\",
    \"name\": \"Jorge\",
    \"person_id\": 123456,
    \"tax_id\": \"123.456.789-00\",
    \"principal\": false,
    \"percentage\": 100,
    \"start_at\": \"2024-01-01\",
    \"end_at\": \"2024-12-31\",
    \"description\": \"Morador principal\",
    \"notes\": \"Observações importantes\"
}"

Obter

GET

https://api.apresenta.me/financial/contracts/{contract_id}/occupants/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

Id do Contrato

Example:

integer

required

Id do Ocupante

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,type,principal

include[person]

string

Incluir dados da Pessoa

Example:

id,name,tax_id

include[contract]

string

Incluir dados do Contrato

Example:

id,reference,type

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/financial/contracts/4/occupants/13?sort=id&fields=id%2Cname%2Ctype%2Cprincipal&include%5Bperson%5D=id%2Cname%2Ctax_id&include%5Bcontract%5D=id%2Creference%2Ctype" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/financial/contracts/{contract_id}/occupants/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

Id do Contrato

Example:

integer

required

Id do Ocupante

Example:

Body Parameters

type

string

Tipo do ocupante. Valores permitidos:

resident: Morador
tenant: Inquilino
guarantor: Fiador
witness: Testemunha
payer: Responsável pelo Pagamento
buyer: Comprador
procurator: Procurador

Example:

resident

name

string

Nome do ocupante

Example:

Jorge

person_id

integer

ID da pessoa

Example:

123456

tax_id

string

CPF/CNPJ

Example:

123.456.789-00

principal

boolean

Ocupante principal

percentage

number

Porcentagem

Example:

100

start_at

date

Data de entrada

Example:

2024-01-01

end_at

date

Data de saída

Example:

2024-12-31

description

string

Descrição

Example:

Morador principal

notes

string

Observações

Example:

Observações importantes

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/financial/contracts/20/occupants/16" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"resident\",
    \"name\": \"Jorge\",
    \"person_id\": 123456,
    \"tax_id\": \"123.456.789-00\",
    \"principal\": false,
    \"percentage\": 100,
    \"start_at\": \"2024-01-01\",
    \"end_at\": \"2024-12-31\",
    \"description\": \"Morador principal\",
    \"notes\": \"Observações importantes\"
}"

Excluir

DELETE

https://api.apresenta.me/financial/contracts/{contract_id}/occupants/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

ID do Contrato

Example:

integer

required

Id do Ocupante

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/financial/contracts/15/occupants/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Contratos » Itens

Pesquisar

GET

https://api.apresenta.me/financial/contracts/{contract_id}/items

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

required

ID do Contrato

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description,contract_id

filter[mode]

string

Filtra por modo do item. Valores permitidos:

item: Padrão
commission: Comissão
service: Serviço

Example:

item

filter[item_id]

integer

Filtra por ID do tipo de item

Example:

filter[parent_id]

integer

Filtra por ID do item pai

Example:

filter[contract_id]

integer

Filtra por ID do contrato

Example:

filter[transfer_owner_id]

integer

Filtra por ID do proprietário da transferência

Example:

filter[broker_id]

integer

Filtra por ID do corretor

Example:

filter[start_at]

string

date Filtra por mês inicial

Example:

2024-01-01

filter[end_at]

string

date Filtra por mês final

Example:

2024-12-31

filter[description]

string

Filtra por descritivo do Item

Example:

Aluguel

filter[amount]

number

Filtra por valor

Example:

1000

filter[calculate_mode]

string

Filtra por tipo de valor. Valores permitidos:

percentage: Porcentagem
fixed: Valor fixo

Example:

fixed

filter[percentage]

number

Filtra por porcentagem

Example:

filter[percentage_mode]

string

Filtra por base de cálculo de porcentagem. Valores permitidos:

rental_value: Valor da Locação
recurring_commission: Comissão Recorrente
first_commission: Primeira Comissão

Example:

rental_value

filter[commissioned_type]

string

Filtra por tipo de comissionado. Valores permitidos:

seller: Corretor Vendedor
broker: Corretor Agenciador
pickup: Captador/Angariador
indicator: Indicador
partner: Parceria
manager: Gerente
director: Diretor
supervisor: Supervisor
marketing: Marketing
coordinator: Coordenador
others: Outros

Example:

seller

filter[item_default]

boolean

Filtra por item padrão

Example:

filter[modeIn][]

string[]

Filtra por modos do item

filter[contractIn][]

integer[]

Filtra por contratos

Example:

filter[ownerIn][]

integer[]

Filtra por proprietários

Example:

filter[amountMin]

number

Filtra por valor mínimo

Example:

1000

filter[withReadjust]

boolean

Filtra por valor mínimo

Example:

include[item]

string

Incluir dados do Item

Example:

id,description,type

include[contract]

string

Incluir dados do Contrato

Example:

id,reference,type

include[parent]

string

Incluir dados do Item Pai

Example:

id,description

include[transfer_owner]

string

Incluir dados do Proprietário

Example:

id,name,tax_id

include[broker]

string

Incluir dados do Corretor

Example:

id,name,email

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/financial/contracts/13/items?sort=id&fields=id%2Cdescription%2Ccontract_id&filter%5Bmode%5D=item&filter%5Bitem_id%5D=1&filter%5Bparent_id%5D=1&filter%5Bcontract_id%5D=1&filter%5Btransfer_owner_id%5D=1&filter%5Bbroker_id%5D=1&filter%5Bstart_at%5D=2024-01-01&filter%5Bend_at%5D=2024-12-31&filter%5Bdescription%5D=Aluguel&filter%5Bamount%5D=1000&filter%5Bcalculate_mode%5D=fixed&filter%5Bpercentage%5D=10&filter%5Bpercentage_mode%5D=rental_value&filter%5Bcommissioned_type%5D=seller&filter%5Bitem_default%5D=1&filter%5BmodeIn%5D%5B%5D=&filter%5BcontractIn%5D%5B%5D=1&filter%5BownerIn%5D%5B%5D=1&filter%5BamountMin%5D=1000&filter%5BwithReadjust%5D=1&include%5Bitem%5D=id%2Cdescription%2Ctype&include%5Bcontract%5D=id%2Creference%2Ctype&include%5Bparent%5D=id%2Cdescription&include%5Btransfer_owner%5D=id%2Cname%2Ctax_id&include%5Bbroker%5D=id%2Cname%2Cemail" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/financial/contracts/{contract_id}/items

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

required

Id do Contrato

Example:

Body Parameters

mode

string

required

Modo do item. Valores permitidos:

item: Padrão
commission: Comissão
service: Serviço

Example:

item

item_id

integer

required

ID do tipo de item

Example:

description

string

required

Descrição do Item

Example:

Aluguel

calculate_mode

string

required

Tipo de valor. Valores permitidos:

percentage: Porcentagem
fixed: Valor fixo

Example:

fixed

parent_id

integer

ID do item pai

Example:

percentage

number

Porcentagem

Example:

amount

number

Valor fixo

Example:

1000

percentage_mode

string

Base de cálculo de porcentagem. Valores permitidos:

rental_value: Valor da Locação
recurring_commission: Comissão Recorrente
first_commission: Primeira Comissão

Example:

rental_value

transfer_owner_id

integer

ID do proprietário da transferência

Example:

broker_id

integer

ID do corretor

Example:

start_at

date

Data inicial

Example:

2024-01-01

end_at

date

Data final

Example:

2024-12-31

commissioned_type

string

Tipo de comissionado. Valores permitidos:

seller: Corretor Vendedor
broker: Corretor Agenciador
pickup: Captador/Angariador
indicator: Indicador
partner: Parceria
manager: Gerente
director: Diretor
supervisor: Supervisor
marketing: Marketing
coordinator: Coordenador
others: Outros

Example:

seller

config

json

Configurações.

Example:

{"installment": 1, "billing_mode": "monthly"}

Auth

Bearer

Headers

URL Parameters

Body

{ "mode": "item", "item_id": 1, "description": "Aluguel", "calculate_mode": "fixed", "parent_id": 1, "percentage": 10, "amount": 1000, "percentage_mode": "rental_value", "transfer_owner_id": 1, "broker_id": 1, "start_at": "2024-01-01", "end_at": "2024-12-31", "commissioned_type": "seller", "config": "{\"installment\": 1, \"billing_mode\": \"monthly\"}" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/financial/contracts/2/items" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"mode\": \"item\",
    \"item_id\": 1,
    \"description\": \"Aluguel\",
    \"calculate_mode\": \"fixed\",
    \"parent_id\": 1,
    \"percentage\": 10,
    \"amount\": 1000,
    \"percentage_mode\": \"rental_value\",
    \"transfer_owner_id\": 1,
    \"broker_id\": 1,
    \"start_at\": \"2024-01-01\",
    \"end_at\": \"2024-12-31\",
    \"commissioned_type\": \"seller\",
    \"config\": \"{\\\"installment\\\": 1, \\\"billing_mode\\\": \\\"monthly\\\"}\"
}"

Obter

GET

https://api.apresenta.me/financial/contracts/{contract_id}/items/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

Id do Contrato

Example:

integer

required

Id do Item

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description,contract_id

include[item]

string

Incluir dados do Item

Example:

id,description,type

include[contract]

string

Incluir dados do Contrato

Example:

id,reference,type

include[parent]

string

Incluir dados do Item Pai

Example:

id,description

include[transfer_owner]

string

Incluir dados do Proprietário

Example:

id,name,tax_id

include[broker]

string

Incluir dados do Corretor

Example:

id,name,email

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/financial/contracts/15/items/3?sort=id&fields=id%2Cdescription%2Ccontract_id&include%5Bitem%5D=id%2Cdescription%2Ctype&include%5Bcontract%5D=id%2Creference%2Ctype&include%5Bparent%5D=id%2Cdescription&include%5Btransfer_owner%5D=id%2Cname%2Ctax_id&include%5Bbroker%5D=id%2Cname%2Cemail" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/financial/contracts/{contract_id}/items/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

Id do Contrato

Example:

integer

required

Id do Item

Example:

Body Parameters

mode

string

Modo do item. Valores permitidos:

item: Padrão
commission: Comissão
service: Serviço

Example:

item

item_id

integer

ID do tipo de item

Example:

parent_id

integer

ID do item pai

Example:

description

string

Descrição do Item

Example:

Aluguel

calculate_mode

string

Tipo de valor. Valores permitidos:

percentage: Porcentagem
fixed: Valor fixo

Example:

fixed

percentage

number

Porcentagem

Example:

amount

number

Valor fixo

Example:

1000

percentage_mode

string

Base de cálculo de porcentagem. Valores permitidos:

rental_value: Valor da Locação
recurring_commission: Comissão Recorrente
first_commission: Primeira Comissão

Example:

rental_value

transfer_owner_id

integer

ID do proprietário da transferência

Example:

broker_id

integer

ID do corretor

Example:

start_at

date

Data inicial

Example:

2024-01-01

end_at

date

Data final

Example:

2024-12-31

commissioned_type

string

Tipo de comissionado. Valores permitidos:

seller: Corretor Vendedor
broker: Corretor Agenciador
pickup: Captador/Angariador
indicator: Indicador
partner: Parceria
manager: Gerente
director: Diretor
supervisor: Supervisor
marketing: Marketing
coordinator: Coordenador
others: Outros

Example:

seller

Auth

Bearer

Headers

URL Parameters

Body

{ "mode": "item", "item_id": 1, "parent_id": 1, "description": "Aluguel", "calculate_mode": "fixed", "percentage": 10, "amount": 1000, "percentage_mode": "rental_value", "transfer_owner_id": 1, "broker_id": 1, "start_at": "2024-01-01", "end_at": "2024-12-31", "commissioned_type": "seller" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/financial/contracts/5/items/4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"mode\": \"item\",
    \"item_id\": 1,
    \"parent_id\": 1,
    \"description\": \"Aluguel\",
    \"calculate_mode\": \"fixed\",
    \"percentage\": 10,
    \"amount\": 1000,
    \"percentage_mode\": \"rental_value\",
    \"transfer_owner_id\": 1,
    \"broker_id\": 1,
    \"start_at\": \"2024-01-01\",
    \"end_at\": \"2024-12-31\",
    \"commissioned_type\": \"seller\"
}"

Excluir

DELETE

https://api.apresenta.me/financial/contracts/{contract_id}/items/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract_id

integer

Id do Contrato

Example:

integer

required

Id do Item

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/financial/contracts/4/items/12" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Contratos

Gerar Parcelas

POST

https://api.apresenta.me/financial/contracts/{contract}/invoicesCreate

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contract

integer

required

ID do contrato

Example:

Body Parameters

preview

boolean

Caso informado, o sistema irá mostrar uma prévia das faturas que será gerada

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "preview": true }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/financial/contracts/7/invoicesCreate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"preview\": true
}"

Pesquisar

GET

https://api.apresenta.me/financial/contracts

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,reference,deal_id

filter[id]

integer

ID do contrato

Example:

123123

filter[id2]

integer

ID do contrato

Example:

123123

filter[building_id]

integer

ID do Imóvel

Example:

123456

filter[tenant_id]

integer

ID do Inquilino

Example:

123456

filter[billing_id]

integer

ID do método de pagamento

Example:

123456

filter[reference]

string

Código de referência

Example:

CONTR-001

filter[type]

string

Tipo do contrato. Valores permitidos:

rent: Anual
season: Temporada
sale: Venda
subscription: Assinatura

Example:

rent

filter[sale_type]

string

Tipo de venda. Valores permitidos:

deed_registration: Escritura/Registro
financing: Financiamento
private_document: Documento Particular
assignment_of_rights: Cessão de direito

Example:

deed_registration

filter[active]

string

Status de atividade. Valores permitidos:

active: Ativo
pre_reserved: Pré-Reservado
reserved: Reservado
suspended: Suspenso
canceled: Cancelado
finished: Concluído

Example:

active

filter[active_date]

string

Data de alteração da atividade

Example:

2024-01-01

filter[status]

string

Status do contrato. Valores permitidos:

progress: Em Andamento
closing: Encerrando
readjust: Aguardando Reajuste
renew: Aguardando Renovação
no_invoices: Contrato sem Faturas
suspended: Suspenso
pending: Pendente
finished: Finalizado
canceled: Cancelado
terminating: Aguardando Rescisão
on_notice: Em Aviso Prévio
terminated: Rescindido

Example:

no_invoices

filter[status_date]

string

Data de alteração do status

Example:

2024-01-01

filter[payment_status]

string

Status de pagamento. Valores permitidos:

due_5_days: Vence em 5 dias
nothing: Nada a pagar
ok: Pagamento em Dia
5_days: Menos de 5 dias Vencido
30_days: Menos de um mês Vencido
month: Mais de um mês Vencido
3_months: Mais de três meses Vencido

Example:

filter[payment_status_date]

string

Data de alteração do status de pagamento

Example:

2024-01-01

filter[user_id]

integer

ID do usuário responsável

Example:

123456

filter[agent_id]

integer

ID do corretor

Example:

123456

filter[procurator_id]

integer

ID do procurador

Example:

123456

filter[team_id]

integer

ID da equipe

Example:

123456

filter[access]

string

Nível de acesso. Valores permitidos:

all: Todos os Usuários
responsible: Usuários Responsáveis

Example:

all

filter[tag]

string

Criar

POST

https://api.apresenta.me/financial/contracts

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

type

string

required

Tipo do contrato. Valores permitidos:

rent: Anual
season: Temporada
sale: Venda
subscription: Assinatura

Example:

rent

building_id

integer

required

ID do Imóvel

Example:

123456

tenant_id

integer

required

ID do Inquilino

Example:

123456

billing_id

integer

required

ID do método de pagamento

Example:

123456

start_at

string

required

Data de início

Example:

2024-01-01

recurrency

string

required

Recorrência. Valores permitidos:

daily: Diariamente
monthly: Mensalmente

Example:

monthly

amount

number

required

Valor do contrato

Example:

1500

business_id

integer

required

ID da empresa

Example:

123456

account_id

integer

required

ID da conta financeira

Example:

123456

billing_method

string

required

Tipo de pagamento ao proprietário. Valores permitidos:

ticket: Boleto
cash: Dinheiro
deposit: Depósito
pix: PIX
ted: DOC/TED
credit: Cartão de Crédito
debit: Cartão de Débito
check: Cheque
debit_account: Débito em Conta

Example:

pix

due_date

string

Data do vencimento

Example:

2024-01-05

sale_type

string

Tipo de venda. Valores permitidos:

deed_registration: Escritura/Registro
financing: Financiamento
private_document: Documento Particular
assignment_of_rights: Cessão de direito

Example:

deed_registration

reference

string

Código de referência

Example:

CONTR-001

active

string

Status de atividade. Valores permitidos:

active: Ativo
pre_reserved: Pré-Reservado
reserved: Reservado
suspended: Suspenso
canceled: Cancelado
finished: Concluído

Example:

active

active_date

string

Data de alteração da atividade

Example:

2024-01-01

status

string

Status do contrato. Valores permitidos:

progress: Em Andamento
closing: Encerrando
readjust: Aguardando Reajuste
renew: Aguardando Renovação
no_invoices: Contrato sem Faturas
suspended: Suspenso
pending: Pendente
finished: Finalizado
canceled: Cancelado
terminating: Aguardando Rescisão
on_notice: Em Aviso Prévio
terminated: Rescindido

Example:

no_invoices

status_date

string

Data de alteração do status

Example:

2024-01-01

payment_status

string

Status de pagamento. Valores permitidos:

due_5_days: Vence em 5 dias
nothing: Nada a pagar
ok: Pagamento em Dia
5_days: Menos de 5 dias Vencido
30_days: Menos de um mês Vencido
month: Mais de um mês Vencido
3_months: Mais de três meses Vencido

Example:

payment_status_date

string

Data de alteração do status de pagamento

Example:

2024-01-01

user_id

integer

ID do usuário responsável

Example:

123456

agent_id

integer

ID do corretor

Example:

123456

procurator_id

integer

ID do procurador

Example:

123456

team_id

integer

ID da equipe

Example:

123456

access

string

Nível de acesso. Valores permitidos:

all: Todos os Usuários
responsible: Usuários Responsáveis

Example:

all

tag

string

Obter

GET

https://api.apresenta.me/financial/contracts/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do contrato

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,reference,deal_id

include[occupants]

string

Incluir dados dos Ocupantes

Example:

id,name,type

include[buyers]

string

Incluir dados dos Compradores

Example:

id,name,type

include[vehicles]

string

Incluir dados dos Veículos

Example:

id,brand,model

include[tickets]

string

Incluir dados dos Atendimentos

Example:

id,title

include[inspects]

string

Incluir dados dos Atendimentos

Example:

id,type,status

include[business]

string

Incluir dados da Empresa

Example:

id,name

include[building]

string

Incluir dados do Imóvel

Example:

id,title

include[billing]

string

Incluir dados da Empresa de Cobrança

Example:

id,name

include[account]

string

Incluir dados da Conta Financeira

Example:

id,name

include[user]

string

Incluir dados do Responsável pelo Contrato

Example:

id,name

include[renewed]

string

Incluir dados do Contrato Pai que gerou este

Example:

id,deal_id

include[renewedTo]

string

Incluir dados do Contrato Filho que este gerou

Example:

id,deal_id

include[team]

string

Incluir dados da Equipe de Venda/Locação

Example:

id,name

include[tenant]

string

Incluir dados do Inquilino

Example:

id,name

include[owners]

string

Incluir dados dos Proprietários

Example:

id,name

include[invoices]

string

Incluir dados das Faturas

Example:

id,amount

include[items]

string

Incluir dados dos Itens

Example:

id,description,amount

include[commissions]

string

Incluir dados das Comissões

Example:

id,description,amount

include[insurances]

string

Incluir dados dos Seguros

Example:

id,type,amount

include[files]

string

Incluir dados dos Arquivos

Example:

id,name,url

include[documentables]

string

Incluir dados dos Documentos (estrutura documentables)

Example:

id,template_id,privacy

include[deal]

string

Incluir dados do Negócio

Example:

id,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/financial/contracts/14?sort=id&fields=id%2Creference%2Cdeal_id&include%5Boccupants%5D=id%2Cname%2Ctype&include%5Bbuyers%5D=id%2Cname%2Ctype&include%5Bvehicles%5D=id%2Cbrand%2Cmodel&include%5Btickets%5D=id%2Ctitle&include%5Binspects%5D=id%2Ctype%2Cstatus&include%5Bbusiness%5D=id%2Cname&include%5Bbuilding%5D=id%2Ctitle&include%5Bbilling%5D=id%2Cname&include%5Baccount%5D=id%2Cname&include%5Buser%5D=id%2Cname&include%5Brenewed%5D=id%2Cdeal_id&include%5BrenewedTo%5D=id%2Cdeal_id&include%5Bteam%5D=id%2Cname&include%5Btenant%5D=id%2Cname&include%5Bowners%5D=id%2Cname&include%5Binvoices%5D=id%2Camount&include%5Bitems%5D=id%2Cdescription%2Camount&include%5Bcommissions%5D=id%2Cdescription%2Camount&include%5Binsurances%5D=id%2Ctype%2Camount&include%5Bfiles%5D=id%2Cname%2Curl&include%5Bdocumentables%5D=id%2Ctemplate_id%2Cprivacy&include%5Bdeal%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/financial/contracts/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do contrato

Example:

Body Parameters

type

string

Tipo do contrato. Valores permitidos:

rent: Anual
season: Temporada
sale: Venda
subscription: Assinatura

Example:

rent

sale_type

string

Tipo de venda. Valores permitidos:

deed_registration: Escritura/Registro
financing: Financiamento
private_document: Documento Particular
assignment_of_rights: Cessão de direito

Example:

deed_registration

building_id

integer

ID do Imóvel

Example:

123456

tenant_id

integer

ID do Inquilino

Example:

123456

billing_id

integer

ID do método de pagamento

Example:

123456

reference

string

Código de referência

Example:

CONTR-001

active

string

Status de atividade. Valores permitidos:

active: Ativo
pre_reserved: Pré-Reservado
reserved: Reservado
suspended: Suspenso
canceled: Cancelado
finished: Concluído

Example:

active

active_date

string

Data de alteração da atividade

Example:

2024-01-01

status

string

Status do contrato. Valores permitidos:

progress: Em Andamento
closing: Encerrando
readjust: Aguardando Reajuste
renew: Aguardando Renovação
no_invoices: Contrato sem Faturas
suspended: Suspenso
pending: Pendente
finished: Finalizado
canceled: Cancelado
terminating: Aguardando Rescisão
on_notice: Em Aviso Prévio
terminated: Rescindido

Example:

active

status_date

string

Data de alteração do status

Example:

2024-01-01

payment_status

string

Status de pagamento. Valores permitidos:

due_5_days: Vence em 5 dias
nothing: Nada a pagar
ok: Pagamento em Dia
5_days: Menos de 5 dias Vencido
30_days: Menos de um mês Vencido
month: Mais de um mês Vencido
3_months: Mais de três meses Vencido

Example:

payment_status_date

string

Data de alteração do status de pagamento

Example:

2024-01-01

user_id

integer

ID do usuário responsável

Example:

123456

agent_id

integer

ID do corretor

Example:

123456

procurator_id

integer

ID do procurador

Example:

123456

team_id

integer

ID da equipe

Example:

123456

access

string

Nível de acesso. Valores permitidos:

all: Todos os Usuários
responsible: Usuários Responsáveis

Example:

all

tag

string

Excluir

DELETE

https://api.apresenta.me/financial/contracts/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do contrato

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/financial/contracts/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Grupos de Usuários

Pesquisar

GET

https://api.apresenta.me/users/groups

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name

filter[id]

integer

Código do Grupo.

Example:

filter[name]

string

Nome do Grupo.

Example:

Corretores

filter[type]

string

Tipo de Grupo.

Example:

normal

filter[notes]

string

Observação.

Example:

Grupo de usuários corretores

include[users]

string

Retorna os usuários do grupo.

Example:

id,name

include[permissions]

string

Retorna as permissões do grupo.

Example:

permission

include[buildings]

string

Retorna os imóveis que o grupo é responsável.

Example:

id,title

include[persons]

string

Retorna as pessoas que o grupo é responsável.

Example:

id,name,type

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/users/groups?sort=id&fields=id%2Cname&filter%5Bid%5D=1&filter%5Bname%5D=Corretores&filter%5Btype%5D=normal&filter%5Bnotes%5D=Grupo+de+usu%C3%A1rios+corretores&include%5Busers%5D=id%2Cname&include%5Bpermissions%5D=permission&include%5Bbuildings%5D=id%2Ctitle&include%5Bpersons%5D=id%2Cname%2Ctype" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/users/groups

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

type

string

required

Tipo do grupo.

Example:

normal

name

string

required

Nome do grupo.

Example:

Corretores - Locação

notes

string

Observação para o grupo.

Example:

Este é um grupo para corretores de locação

Auth

Bearer

Headers

Body

{ "type": "normal", "name": "Corretores - Loca\u00e7\u00e3o", "notes": "Este \u00e9 um grupo para corretores de loca\u00e7\u00e3o" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/users/groups" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"normal\",
    \"name\": \"Corretores - Locação\",
    \"notes\": \"Este é um grupo para corretores de locação\"
}"

Obter

GET

https://api.apresenta.me/users/groups/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Grupo

Example:

1096

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name

include[users]

string

Retorna os usuários do grupo.

Example:

id,name

include[permissions]

string

Retorna as permissões do grupo.

Example:

permission

include[buildings]

string

Retorna os imóveis que o grupo é responsável.

Example:

id,title

include[persons]

string

Retorna as pessoas que o grupo é responsável.

Example:

id,name,type

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/users/groups/1096?sort=id&fields=id%2Cname&include%5Busers%5D=id%2Cname&include%5Bpermissions%5D=permission&include%5Bbuildings%5D=id%2Ctitle&include%5Bpersons%5D=id%2Cname%2Ctype" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/users/groups/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Grupo

Example:

1096

Body Parameters

type

string

Tipo do grupo.

Example:

normal

name

string

Nome do grupo.

Example:

Corretores - Locação

notes

string

Observação para o grupo.

Example:

Este é um grupo para corretores de locação

Auth

Bearer

Headers

URL Parameters

Body

{ "type": "normal", "name": "Corretores - Loca\u00e7\u00e3o", "notes": "Este \u00e9 um grupo para corretores de loca\u00e7\u00e3o" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/users/groups/1096" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"normal\",
    \"name\": \"Corretores - Locação\",
    \"notes\": \"Este é um grupo para corretores de locação\"
}"

Excluir

DELETE

https://api.apresenta.me/users/groups/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Grupo

Example:

1096

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/users/groups/1096" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Duplicar

POST

https://api.apresenta.me/users/groups/{group_id}/duplicate

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

group_id

integer

required

The ID of the group.

Example:

integer

required

ID do Grupo de Usuário

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/users/groups/2/duplicate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Históricos

Tipos

Pesquisar

GET

https://api.apresenta.me/history/types

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description

filter[id]

integer

ID do tipo.

Example:

filter[description]

integer

ID do tipo.

Example:

filter[modules]

string[]

Módulos do tipo.

filter[icon]

string

Ícone.

Example:

ca-icon-example

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/history/types?sort=id&fields=id%2Cdescription&filter%5Bid%5D=1&filter%5Bdescription%5D=1&filter%5Bmodules%5D=&filter%5Bicon%5D=ca-icon-example" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/history/types

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

description

integer

required

ID do tipo.

Example:

modules

string[]

required

Módulos do tipo.

icon

string

Ícone. required.

Example:

ca-icon-example

Auth

Bearer

Headers

Body

{ "description": 1, "modules": null, "icon": "ca-icon-example" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/history/types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": 1,
    \"modules\": null,
    \"icon\": \"ca-icon-example\"
}"

Obter

GET

https://api.apresenta.me/history/types/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Tipo de Histórico

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/history/types/6?sort=id&fields=id%2Cdescription" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/history/types/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Tipo de Histórico

Example:

Body Parameters

description

integer

ID do tipo.

Example:

modules

string[]

Módulos do tipo.

icon

string

Ícone.

Example:

ca-icon-example

Auth

Bearer

Headers

URL Parameters

Body

{ "description": 1, "modules": null, "icon": "ca-icon-example" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/history/types/12" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": 1,
    \"modules\": null,
    \"icon\": \"ca-icon-example\"
}"

Excluir

DELETE

https://api.apresenta.me/history/types/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Tipo de Histórico

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/history/types/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Fixar

PUT

https://api.apresenta.me/history/{history_id}/toggle

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

history_id

integer

required

The ID of the history.

Example:

integer

required

ID do Histórico

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/history/9/toggle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Pesquisar

GET

https://api.apresenta.me/history

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description

filter[id]

integer

Código do histórico.

Example:

filter[history_type_id]

integer

ID do Tipo do Histórico.

Example:

filter[module_type]

string

Módulo que gerou o histórico.

Example:

deal

filter[module_id]

integer

ID do registro do módulo.

Example:

123

filter[date]

string

date Data do Evento.

Example:

2024-01-01

filter[user_id]

integer

Responsável pelo histórico.

Example:

321

filter[person_id]

integer

Código do cliente da Imobiliária vinculado ao módulo.

Example:

1111

filter[description]

string

Descrição.

Example:

Tentei contato com o cliente, mas não houve retorno

filter[child_type]

integer

Módulo Filho.

Example:

filter[child_id]

integer

ID do registro do módulo filho.

Example:

1233

filter[parent_id]

integer

Código do histórico pai, utilizado para resposta de comentários por exemplo.

Example:

321

filter[private]

boolean

Histórico privado.

filter[visualized_by]

string

json[] Usuários que visualizaram o histórico.

Example:

[{"user":1233,"dateTime":"2024-10-14T13:38:52.089117Z"}]

filter[mentions]

integer[]

Código dos usuários mencionados.

Example:

[123,3131]

filter[fixed]

boolean

Histórico fixado.

include[module]

string

Retorna os dados do registro que gerou o histórico.

Example:

id,title

include[child]

string

Retorna os dados do registro filho que gerou o histórico.

Example:

id,title

include[replies]

string

Retorna as respostas vinculadas ao histórico pai.

Example:

id,description

include[parent]

string

Retorna os dados do histórico pai.

Example:

id,description

include[user]

string

Retorna o usuário que gerou o histórico.

Example:

id,name,email

include[person]

string

Retorna a pessoa/cliente que está vinculada ao histórico.

Example:

id,name

include[type]

string

Retorna o tipo de histórico.

Example:

id,description

include[mentionedUsers]

string

Retorna os usuários mencionados.

Example:

id,name,email

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/history?sort=id&fields=id%2Cdescription&filter%5Bid%5D=1&filter%5Bhistory_type_id%5D=1&filter%5Bmodule_type%5D=deal&filter%5Bmodule_id%5D=123&filter%5Bdate%5D=2024-01-01&filter%5Buser_id%5D=321&filter%5Bperson_id%5D=1111&filter%5Bdescription%5D=Tentei+contato+com+o+cliente%2C+mas+n%C3%A3o+houve+retorno&filter%5Bchild_type%5D=0&filter%5Bchild_id%5D=1233&filter%5Bparent_id%5D=321&filter%5Bprivate%5D=&filter%5Bvisualized_by%5D=%5B%7B%22user%22%3A1233%2C%22dateTime%22%3A%222024-10-14T13%3A38%3A52.089117Z%22%7D%5D&filter%5Bmentions%5D[]=123&filter%5Bmentions%5D[]=3131&filter%5Bfixed%5D=&include%5Bmodule%5D=id%2Ctitle&include%5Bchild%5D=id%2Ctitle&include%5Breplies%5D=id%2Cdescription&include%5Bparent%5D=id%2Cdescription&include%5Buser%5D=id%2Cname%2Cemail&include%5Bperson%5D=id%2Cname&include%5Btype%5D=id%2Cdescription&include%5BmentionedUsers%5D=id%2Cname%2Cemail" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/history

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

integer

Código do histórico.

Example:

history_type_id

integer

required

ID do Tipo do Histórico.

Example:

module_type

string

required

Módulo que gerou o histórico.

Example:

deal

module_id

integer

required

ID do registro do módulo.

Example:

123

date

required

Data do Evento.

Example:

2024-01-01

user_id

integer

Responsável pelo histórico.

Example:

321

person_id

integer

Código do cliente da Imobiliária vinculado ao módulo.

Example:

1111

description

string

required

Descrição.

Example:

Tentei contato com o cliente, mas não houve retorno

child_type

integer

Módulo Filho.

Example:

child_id

integer

ID do registro do módulo filho.

Example:

1233

parent_id

integer

Código do histórico pai, utilizado para resposta de comentários por exemplo.

Example:

321

private

boolean

Histórico privado.

visualized_by

json[]

Usuários que visualizaram o histórico.

Example:

[{"user":1233,"dateTime":"2024-10-14T13:38:52.089117Z"}]

mentions

integer[]

Código dos usuários mencionados.

Example:

[123,3131]

fixed

boolean

Histórico fixado.

Auth

Bearer

Headers

Body

{ "id": 1, "history_type_id": 1, "module_type": "deal", "module_id": 123, "date": "2024-01-01", "user_id": 321, "person_id": 1111, "description": "Tentei contato com o cliente, mas n\u00e3o houve retorno", "child_type": 0, "child_id": 1233, "parent_id": 321, "private": false, "visualized_by": [ { "user": 1233, "dateTime": "2024-10-14T13:38:52.089117Z" } ], "mentions": [ 123, 3131 ], "fixed": false }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/history" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 1,
    \"history_type_id\": 1,
    \"module_type\": \"deal\",
    \"module_id\": 123,
    \"date\": \"2024-01-01\",
    \"user_id\": 321,
    \"person_id\": 1111,
    \"description\": \"Tentei contato com o cliente, mas não houve retorno\",
    \"child_type\": 0,
    \"child_id\": 1233,
    \"parent_id\": 321,
    \"private\": false,
    \"visualized_by\": [
        {
            \"user\": 1233,
            \"dateTime\": \"2024-10-14T13:38:52.089117Z\"
        }
    ],
    \"mentions\": [
        123,
        3131
    ],
    \"fixed\": false
}"

Obter

GET

https://api.apresenta.me/history/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Histórico

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description

include[module]

string

Retorna os dados do registro que gerou o histórico.

Example:

id,title

include[child]

string

Retorna os dados do registro filho que gerou o histórico.

Example:

id,title

include[replies]

string

Retorna as respostas vinculadas ao histórico pai.

Example:

id,description

include[parent]

string

Retorna os dados do histórico pai.

Example:

id,description

include[user]

string

Retorna o usuário que gerou o histórico.

Example:

id,name,email

include[person]

string

Retorna a pessoa/cliente que está vinculada ao histórico.

Example:

id,name

include[type]

string

Retorna o tipo de histórico.

Example:

id,description

include[mentionedUsers]

string

Retorna os usuários mencionados.

Example:

id,name,email

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/history/2?sort=id&fields=id%2Cdescription&include%5Bmodule%5D=id%2Ctitle&include%5Bchild%5D=id%2Ctitle&include%5Breplies%5D=id%2Cdescription&include%5Bparent%5D=id%2Cdescription&include%5Buser%5D=id%2Cname%2Cemail&include%5Bperson%5D=id%2Cname&include%5Btype%5D=id%2Cdescription&include%5BmentionedUsers%5D=id%2Cname%2Cemail" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/history/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Histórico

Example:

Body Parameters

integer

Código do histórico.

Example:

history_type_id

integer

ID do Tipo do Histórico.

Example:

module_type

string

Módulo que gerou o histórico.

Example:

deal

module_id

integer

ID do registro do módulo.

Example:

123

date

Data do Evento.

Example:

2024-01-01

user_id

integer

Responsável pelo histórico.

Example:

321

person_id

integer

Código do cliente da Imobiliária vinculado ao módulo.

Example:

1111

description

string

Descrição.

Example:

Tentei contato com o cliente, mas não houve retorno

child_type

integer

Módulo Filho.

Example:

child_id

integer

ID do registro do módulo filho.

Example:

1233

parent_id

integer

Código do histórico pai, utilizado para resposta de comentários por exemplo.

Example:

321

private

boolean

Histórico privado.

visualized_by

json[]

Usuários que visualizaram o histórico.

Example:

[{"user":1233,"dateTime":"2024-10-14T13:38:52.089117Z"}]

mentions

integer[]

Código dos usuários mencionados.

Example:

[123,3131]

fixed

boolean

Histórico fixado.

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/history/5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 1,
    \"history_type_id\": 1,
    \"module_type\": \"deal\",
    \"module_id\": 123,
    \"date\": \"2024-01-01\",
    \"user_id\": 321,
    \"person_id\": 1111,
    \"description\": \"Tentei contato com o cliente, mas não houve retorno\",
    \"child_type\": 0,
    \"child_id\": 1233,
    \"parent_id\": 321,
    \"private\": false,
    \"visualized_by\": [
        {
            \"user\": 1233,
            \"dateTime\": \"2024-10-14T13:38:52.089117Z\"
        }
    ],
    \"mentions\": [
        123,
        3131
    ],
    \"fixed\": false
}"

Excluir

DELETE

https://api.apresenta.me/history/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Histórico

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/history/11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Imóveis

Finalidades

Pesquisar

GET

https://api.apresenta.me/buildings/{building_id}/purposes

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

amount

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

type,amount

filter[type]

string

Tipo de finalidade.

Example:

sale

filter[currency]

string

Código da moeda.

Example:

BRL

filter[amount]

number

Valor.

Example:

1300

filter[amount_max]

number

Valor Máximo.

Example:

1500

filter[discount_type]

number

Valor Máximo.

Example:

1500

filter[discount]

number

Valor Máximo.

Example:

1500

filter[condition]

string

Condição de pagamento.

Example:

monthly

filter[accepts]

string

Opções de pagamento.

Example:

FGTS

filter[acceptance_notes]

string

Observações para Opções de pagamento.

Example:

Apenas para Aposentados

filter[iptu_amount]

number

Valor do IPTU.

Example:

1750

filter[iptu_installment]

integer

Quantidade em que pode-se parcelar o valor do IPTU.

Example:

filter[condominium]

number

Valor do Condomínio.

Example:

250

filter[tax]

number

Valor das taxas.

Example:

100

filter[show_tax]

boolean

Divulga Taxas.

filter[show]

boolean

Divulga Finalidade.

Example:

filter[show_pack]

boolean

Divulga Pacotes de Temporada.

Example:

filter[season_low_active]

boolean

Baixa Temporada Ativa.

Example:

filter[season_low_condition]

string

Condição de pagamento da Baixa Temporada.

Example:

daily

filter[season_low_tax]

number

Valor das Taxas da Baixa Temporada.

Example:

100

filter[season_high_active]

boolean

Alta Temporada Ativa.

Example:

filter[season_high_condition]

string

Condição de pagamento da Alta Temporada.

Example:

daily

filter[season_high_tax]

number

Valor das Taxas da Alta Temporada.

Example:

150

filter[comission]

number

Porcentagem de Comissão.

Example:

filter[first_commission]

number

Porcentagem da primeira Comissão.

Example:

filter[iptu_free]

boolean

IPTU isento.

Example:

filter[condominium_free]

boolean

Condomínio isento.

include[building]

string

Retorna os dados do imóvel .

Example:

id,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/2/purposes?sort=amount&fields=type%2Camount&filter%5Btype%5D=sale&filter%5Bcurrency%5D=BRL&filter%5Bamount%5D=1300&filter%5Bamount_max%5D=1500&filter%5Bdiscount_type%5D=1500&filter%5Bdiscount%5D=1500&filter%5Bcondition%5D=monthly&filter%5Baccepts%5D=FGTS&filter%5Bacceptance_notes%5D=Apenas+para+Aposentados&filter%5Biptu_amount%5D=1750&filter%5Biptu_installment%5D=15&filter%5Bcondominium%5D=250&filter%5Btax%5D=100&filter%5Bshow_tax%5D=&filter%5Bshow%5D=1&filter%5Bshow_pack%5D=1&filter%5Bseason_low_active%5D=1&filter%5Bseason_low_condition%5D=daily&filter%5Bseason_low_tax%5D=100&filter%5Bseason_high_active%5D=1&filter%5Bseason_high_condition%5D=daily&filter%5Bseason_high_tax%5D=150&filter%5Bcomission%5D=20&filter%5Bfirst_commission%5D=40&filter%5Biptu_free%5D=1&filter%5Bcondominium_free%5D=&include%5Bbuilding%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/buildings/{building_id}/purposes

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel

Example:

Body Parameters

type

string

Tipo de finalidade.

Example:

sale

currency

string

Código da moeda.

Example:

BRL

amount

number

Valor.

Example:

1300

amount_max

number

Valor Máximo.

Example:

1500

discount_type

string

Tipo de Desconto. Valores permitidos:

value: Valor
percentage: Porcentagem
disabled: Sem Desconto

Example:

value

discount

number

Valor do Desconto.

Example:

1500

condition

string

Condição de pagamento.

Example:

monthly

accepts

string

Opções de pagamento.

Example:

FGTS

acceptance_notes

string

Observações para Opções de pagamento.

Example:

Apenas para Aposentados

iptu_amount

number

Valor do IPTU.

Example:

1750

iptu_installment

integer

Quantidade em que pode-se parcelar o valor do IPTU.

Example:

condominium

number

Valor do Condomínio.

Example:

250

tax

number

Valor das taxas.

Example:

100

show_tax

boolean

Divulga Taxas.

Example:

show

boolean

Divulga Finalidade.

show_pack

boolean

Divulga Pacotes de Temporada.

season_low_active

boolean

Baixa Temporada Ativa.

season_low_condition

string

Condição de pagamento da Baixa Temporada.

Example:

daily

season_low_tax

number

Valor das Taxas da Baixa Temporada.

Example:

100

season_high_active

boolean

Alta Temporada Ativa.

season_high_condition

string

Condição de pagamento da Alta Temporada.

Example:

daily

season_high_tax

number

Valor das Taxas da Alta Temporada.

Example:

150

comission

number

Porcentagem de Comissão.

Example:

first_commission

number

Porcentagem da primeira Comissão.

Example:

iptu_free

boolean

IPTU isento.

Example:

condominium_free

boolean

Condomínio isento.

sendCreateNotifications

boolean

Envia notificações de criação.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "type": "sale", "currency": "BRL", "amount": 1300, "amount_max": 1500, "discount_type": "value", "discount": 1500, "condition": "monthly", "accepts": "FGTS", "acceptance_notes": "Apenas para Aposentados", "iptu_amount": 1750, "iptu_installment": 16, "condominium": 250, "tax": 100, "show_tax": true, "show": false, "show_pack": false, "season_low_active": false, "season_low_condition": "daily", "season_low_tax": 100, "season_high_active": false, "season_high_condition": "daily", "season_high_tax": 150, "comission": 20, "first_commission": 40, "iptu_free": true, "condominium_free": false, "sendCreateNotifications": true }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/buildings/6/purposes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"sale\",
    \"currency\": \"BRL\",
    \"amount\": 1300,
    \"amount_max\": 1500,
    \"discount_type\": \"value\",
    \"discount\": 1500,
    \"condition\": \"monthly\",
    \"accepts\": \"FGTS\",
    \"acceptance_notes\": \"Apenas para Aposentados\",
    \"iptu_amount\": 1750,
    \"iptu_installment\": 16,
    \"condominium\": 250,
    \"tax\": 100,
    \"show_tax\": true,
    \"show\": false,
    \"show_pack\": false,
    \"season_low_active\": false,
    \"season_low_condition\": \"daily\",
    \"season_low_tax\": 100,
    \"season_high_active\": false,
    \"season_high_condition\": \"daily\",
    \"season_high_tax\": 150,
    \"comission\": 20,
    \"first_commission\": 40,
    \"iptu_free\": true,
    \"condominium_free\": false,
    \"sendCreateNotifications\": true
}"

Obter

GET

https://api.apresenta.me/buildings/{building_id}/purposes/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel

Example:

string

required

The ID of the purpose.

Example:

asperiores

type

string

required

string Tipo de Finalidade

Example:

sale

Query Parameters

sort

string

Campo para ordenar os registros.

Example:

amount

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta.

Example:

type,amount

include[building]

string

Retorna os dados do imóvel .

Example:

id,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/20/purposes/asperiores?sort=amount&fields=type%2Camount&include%5Bbuilding%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/buildings/{building_id}/purposes/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel

Example:

string

required

The ID of the purpose.

Example:

fuga

type

string

required

Tipo de Finalidade

Example:

sale

Body Parameters

type

string

Tipo de finalidade.

Example:

sale

currency

string

Código da moeda.

Example:

BRL

amount

number

Valor.

Example:

1300

amount_max

number

Valor Máximo.

Example:

1500

discount_type

number

Valor Máximo.

Example:

1500

discount

number

Valor Máximo.

Example:

1500

condition

string

Condição de pagamento.

Example:

monthly

accepts

string

Opções de pagamento.

Example:

FGTS

acceptance_notes

string

Observações para Opções de pagamento.

Example:

Apenas para Aposentados

iptu_amount

number

Valor do IPTU.

Example:

1750

iptu_installment

integer

Quantidade em que pode-se parcelar o valor do IPTU.

Example:

condominium

number

Valor do Condomínio.

Example:

250

tax

number

Valor das taxas.

Example:

100

show_tax

boolean

Divulga Taxas.

show

boolean

Divulga Finalidade.

Example:

show_pack

boolean

Divulga Pacotes de Temporada.

season_low_active

boolean

Baixa Temporada Ativa.

Example:

season_low_condition

string

Condição de pagamento da Baixa Temporada.

Example:

daily

season_low_tax

number

Valor das Taxas da Baixa Temporada.

Example:

100

season_high_active

boolean

Alta Temporada Ativa.

Example:

season_high_condition

string

Condição de pagamento da Alta Temporada.

Example:

daily

season_high_tax

number

Valor das Taxas da Alta Temporada.

Example:

150

comission

number

Porcentagem de Comissão.

Example:

first_commission

number

Porcentagem da primeira Comissão.

Example:

iptu_free

boolean

IPTU isento.

Example:

condominium_free

boolean

Condomínio isento.

Auth

Bearer

Headers

URL Parameters

Body

{ "type": "sale", "currency": "BRL", "amount": 1300, "amount_max": 1500, "discount_type": 1500, "discount": 1500, "condition": "monthly", "accepts": "FGTS", "acceptance_notes": "Apenas para Aposentados", "iptu_amount": 1750, "iptu_installment": 18, "condominium": 250, "tax": 100, "show_tax": false, "show": true, "show_pack": false, "season_low_active": true, "season_low_condition": "daily", "season_low_tax": 100, "season_high_active": true, "season_high_condition": "daily", "season_high_tax": 150, "comission": 20, "first_commission": 40, "iptu_free": true, "condominium_free": false }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/buildings/19/purposes/fuga" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"sale\",
    \"currency\": \"BRL\",
    \"amount\": 1300,
    \"amount_max\": 1500,
    \"discount_type\": 1500,
    \"discount\": 1500,
    \"condition\": \"monthly\",
    \"accepts\": \"FGTS\",
    \"acceptance_notes\": \"Apenas para Aposentados\",
    \"iptu_amount\": 1750,
    \"iptu_installment\": 18,
    \"condominium\": 250,
    \"tax\": 100,
    \"show_tax\": false,
    \"show\": true,
    \"show_pack\": false,
    \"season_low_active\": true,
    \"season_low_condition\": \"daily\",
    \"season_low_tax\": 100,
    \"season_high_active\": true,
    \"season_high_condition\": \"daily\",
    \"season_high_tax\": 150,
    \"comission\": 20,
    \"first_commission\": 40,
    \"iptu_free\": true,
    \"condominium_free\": false
}"

Excluir

DELETE

https://api.apresenta.me/buildings/{building_id}/purposes/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel

Example:

string

required

The ID of the purpose.

Example:

rerum

type

string

required

string Tipo de Finalidade

Example:

sale

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/buildings/6/purposes/rerum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Data indisponível

Pesquisar

GET

https://api.apresenta.me/buildings/{building_id}/unavailabity

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,finandial_contract_id,date

filter[id]

integer

ID da data indisponível.

Example:

filter[date]

string

Data.

Example:

21/04/2021

filter[contract_id]

integer

ID do contrato atrelado.

Example:

321321

include[building]

string

Retorna os dados do imóvel atrelado.

Example:

id,title

include[contract]

string

Retorna os dados do contrato atrelado.

Example:

id,type,status

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/3/unavailabity?sort=id&fields=id%2Cfinandial_contract_id%2Cdate&filter%5Bid%5D=1&filter%5Bdate%5D=21%2F04%2F2021&filter%5Bcontract_id%5D=321321&include%5Bbuilding%5D=id%2Ctitle&include%5Bcontract%5D=id%2Ctype%2Cstatus" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/buildings/{building_id}/unavailabity

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel

Example:

Body Parameters

date

string

Data.

Example:

2024-01-24

contract_id

integer

ID do contrato atrelado.

Example:

321321

Auth

Bearer

Headers

URL Parameters

Body

{ "date": "2024-01-24", "contract_id": 321321 }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/buildings/14/unavailabity" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date\": \"2024-01-24\",
    \"contract_id\": 321321
}"

Obter

GET

https://api.apresenta.me/buildings/{building_id}/unavailabity/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel.

Example:

integer

required

ID da Data indisponível.

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,finandial_contract_id,date

include[building]

string

Retorna os dados do imóvel atrelado.

Example:

id,title

include[contract]

string

Retorna os dados do contrato atrelado.

Example:

id,type,status

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/7/unavailabity/16?sort=id&fields=id%2Cfinandial_contract_id%2Cdate&include%5Bbuilding%5D=id%2Ctitle&include%5Bcontract%5D=id%2Ctype%2Cstatus" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/buildings/{building_id}/unavailabity/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel.

Example:

integer

required

ID da Data indisponível.

Example:

Body Parameters

date

string

required

Data.

Example:

2024-01-24

contract_id

integer

ID do contrato atrelado.

Example:

321321

Auth

Bearer

Headers

URL Parameters

Body

{ "date": "2024-01-24", "contract_id": 321321 }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/buildings/4/unavailabity/13" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date\": \"2024-01-24\",
    \"contract_id\": 321321
}"

Excluir

DELETE

https://api.apresenta.me/buildings/{building_id}/unavailabity/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel.

Example:

integer

required

ID da Data indisponível.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/buildings/14/unavailabity/6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Abas

Pesquisar

GET

https://api.apresenta.me/buildings/{building_id}/tabs

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel.

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,position,title,building_id

filter[id]

integer

ID da aba.

Example:

filter[title]

string

Título da Aba.

Example:

Características

filter[position]

integer

Ordem (crescente).

Example:

filter[content]

string

HTML do conteúdo.

Example:

3 Quartos

include[building]

string

Retorna os dados do imóvel.

Example:

id,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/12/tabs?sort=id&fields=id%2Cposition%2Ctitle%2Cbuilding_id&filter%5Bid%5D=1&filter%5Btitle%5D=Caracter%C3%ADsticas&filter%5Bposition%5D=1&filter%5Bcontent%5D=%3Cp%3E3+Quartos%3C%2Fp%3E&include%5Bbuilding%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/buildings/{building_id}/tabs

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel.

Example:

Body Parameters

title

string

Título da Aba.

Example:

Características

position

integer

Ordem (crescente).

Example:

content

string

HTML do conteúdo.

Example:

3 Quartos

Auth

Bearer

Headers

URL Parameters

Body

{ "title": "Caracter\u00edsticas", "position": 1, "content": "

3 Quartos<\/p>" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/buildings/18/tabs" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Características\",
    \"position\": 1,
    \"content\": \"<p>3 Quartos<\\/p>\"
}"

Obter

GET

https://api.apresenta.me/buildings/{building_id}/tabs/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel.

Example:

integer

required

ID da Aba.

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,position,title,building_id

include[building]

string

Retorna os dados do imóvel.

Example:

id,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/9/tabs/12?sort=id&fields=id%2Cposition%2Ctitle%2Cbuilding_id&include%5Bbuilding%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/buildings/{building_id}/tabs/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel.

Example:

integer

required

ID da Aba.

Example:

Body Parameters

title

string

Título da Aba.

Example:

Características

position

integer

Ordem (crescente).

Example:

content

string

HTML do conteúdo.

Example:

3 Quartos

Auth

Bearer

Headers

URL Parameters

Body

{ "title": "Caracter\u00edsticas", "position": 1, "content": "

3 Quartos<\/p>" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/buildings/3/tabs/12" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Características\",
    \"position\": 1,
    \"content\": \"<p>3 Quartos<\\/p>\"
}"

Excluir

DELETE

https://api.apresenta.me/buildings/{building_id}/tabs/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel.

Example:

integer

required

ID da Aba.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/buildings/9/tabs/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Pacote de Temporadas

Pesquisar

GET

https://api.apresenta.me/buildings/{building_id}/seasonPacks

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description,amount

filter[id]

integer

ID do pacote.

Example:

123

filter[currency]

string

Código da moeda.

Example:

BRL

filter[description]

string

Descrição.

Example:

Pacote de Carnaval

filter[amount]

number

Valor.

Example:

5000

filter[starts_at]

string

Data de início.

Example:

07/02/2021

filter[ends_at]

string

Data de fim.

Example:

21/02/2021

include[building]

string

Retorna os dados do imóvel.

Example:

id,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/20/seasonPacks?sort=id&fields=id%2Cdescription%2Camount&filter%5Bid%5D=123&filter%5Bcurrency%5D=BRL&filter%5Bdescription%5D=Pacote+de+Carnaval&filter%5Bamount%5D=5000&filter%5Bstarts_at%5D=07%2F02%2F2021&filter%5Bends_at%5D=21%2F02%2F2021&include%5Bbuilding%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/buildings/{building_id}/seasonPacks

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel.

Example:

integer

required

ID do Pacote de Temporada.

Example:

Body Parameters

currency

string

Código da moeda.

Example:

BRL

description

string

Descrição.

Example:

Pacote de Carnaval

amount

number

Valor.

Example:

5000

starts_at

string

Data de início.

Example:

07/02/2021

ends_at

string

Data de fim.

Example:

21/02/2021

Auth

Bearer

Headers

URL Parameters

Body

{ "currency": "BRL", "description": "Pacote de Carnaval", "amount": 5000, "starts_at": "07\/02\/2021", "ends_at": "21\/02\/2021" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/buildings/13/seasonPacks" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"currency\": \"BRL\",
    \"description\": \"Pacote de Carnaval\",
    \"amount\": 5000,
    \"starts_at\": \"07\\/02\\/2021\",
    \"ends_at\": \"21\\/02\\/2021\"
}"

Obter

GET

https://api.apresenta.me/buildings/{building_id}/seasonPacks/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel.

Example:

integer

required

ID do Pacote de Temporada.

Example:

Query Parameters

sort

string

Campo para ordenar os registros.

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta.

Example:

id,description,amount

include[building]

string

Retorna os dados do imóvel.

Example:

id,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/3/seasonPacks/7?sort=id&fields=id%2Cdescription%2Camount&include%5Bbuilding%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/buildings/{building_id}/seasonPacks/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel.

Example:

integer

required

ID do Pacote de Temporada.

Example:

Body Parameters

currency

string

Código da moeda.

Example:

BRL

description

string

Descrição.

Example:

Pacote de Carnaval

amount

number

Valor.

Example:

5000

starts_at

string

Data de início.

Example:

07/02/2021

ends_at

string

Data de fim.

Example:

21/02/2021

Auth

Bearer

Headers

URL Parameters

Body

{ "currency": "BRL", "description": "Pacote de Carnaval", "amount": 5000, "starts_at": "07\/02\/2021", "ends_at": "21\/02\/2021" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/buildings/14/seasonPacks/7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"currency\": \"BRL\",
    \"description\": \"Pacote de Carnaval\",
    \"amount\": 5000,
    \"starts_at\": \"07\\/02\\/2021\",
    \"ends_at\": \"21\\/02\\/2021\"
}"

Excluir

DELETE

https://api.apresenta.me/buildings/{building_id}/seasonPacks/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel.

Example:

integer

required

ID do Pacote de Temporada.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/buildings/12/seasonPacks/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Estágios

Pesquisar

GET

https://api.apresenta.me/buildings/stages

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

position

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description,percentage

filter[id]

integer

ID do estágio. Example:

Example:

filter[description]

string

Descrição. Example:

Example:

nostrum

filter[percentage_active]

boolean

Utilizar porcentagem para obra.

filter[percentage]

integer

Porcentagem da Obra.

Example:

filter[position]

integer

Ordem dos estágios com porcentagem.

Example:

include[buildings]

string

Retorna os imóveis no estágio.

Example:

id,title,type_id

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/stages?sort=position&fields=id%2Cdescription%2Cpercentage&filter%5Bid%5D=15&filter%5Bdescription%5D=nostrum&filter%5Bpercentage_active%5D=&filter%5Bpercentage%5D=80&filter%5Bposition%5D=2&include%5Bbuildings%5D=id%2Ctitle%2Ctype_id" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/buildings/stages

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

description

string

required

Descrição. Example:

Example:

Qui soluta ut et non error tempora.

percentage_active

boolean

Utilizar porcentagem para obra.

percentage

integer

Porcentagem da Obra.

Example:

position

integer

Ordem dos estágios com porcentagem.

Example:

Auth

Bearer

Headers

Body

{ "description": "Qui soluta ut et non error tempora.", "percentage_active": false, "percentage": 80, "position": 2 }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/buildings/stages" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Qui soluta ut et non error tempora.\",
    \"percentage_active\": false,
    \"percentage\": 80,
    \"position\": 2
}"

Obter

GET

https://api.apresenta.me/buildings/stages/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do estágio.

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

position

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description,percentage

include[buildings]

string

Retorna os imóveis no estágio.

Example:

id,title,type_id

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/stages/4?sort=position&fields=id%2Cdescription%2Cpercentage&include%5Bbuildings%5D=id%2Ctitle%2Ctype_id" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/buildings/stages/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do estágio.

Example:

Body Parameters

description

string

Descrição. Example:

Example:

Sint iure voluptatem aut et quis.

percentage_active

boolean

Utilizar porcentagem para obra.

percentage

integer

Porcentagem da Obra.

Example:

position

integer

Ordem dos estágios com porcentagem.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "description": "Sint iure voluptatem aut et quis.", "percentage_active": false, "percentage": 80, "position": 2 }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/buildings/stages/14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Sint iure voluptatem aut et quis.\",
    \"percentage_active\": false,
    \"percentage\": 80,
    \"position\": 2
}"

Excluir

DELETE

https://api.apresenta.me/buildings/stages/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do estágio.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/buildings/stages/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Movimentação de Chaves

Pesquisar

GET

https://api.apresenta.me/buildings/keys/keyMovements

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,person_id,tax_id

filter[id]

integer

ID da movimentação de chave.

Example:

filter[key_id]

integer

ID da chave.

Example:

filter[person_id]

integer

ID do solicitante.

Example:

filter[user_id]

integer

ID do corretor responsável.

Example:

123

filter[returned]

boolean

Se a chave foi devolvida.

Example:

filter[taked_at]

string

Quando a pessoa retirou.

Example:

20/04/2021

filter[returned_at]

string

Quando a pessoa devolveu.

Example:

30/04/2021

filter[return_prevision]

string

Previsão de devolução.

Example:

30/04/2021

filter[person_name]

string

Nome do solicitante.

Example:

Rogério

filter[person_phone]

string

telefone do solicitante.

Example:

(47) 92860-8431

filter[person_tax_id]

string

CPF do solicitante.

Example:

365.277.520-16

filter[person_zip_code]

string

CEP do solicitante.

Example:

69316-038

filter[country_id]

integer

ID de País do solicitante.

Example:

filter[state_id]

integer

ID de Estado do solicitante.

Example:

filter[city_id]

integer

ID de Cidade do solicitante.

Example:

7375

filter[district_id]

integer

ID de Bairro do solicitante.

Example:

35040

filter[street]

string

Rua do solicitante.

Example:

Rua Z-Y

filter[number]

string

Complemento do solicitante.

Example:

Apartamento

filter[complement]

string

Complemento do solicitante.

Example:

Apartamento

filter[notes]

string

Observações.

Example:

Cliente é de outra cidade

include[user]

string

Retorna dados do corretor responsável.

Example:

id,name

include[person]

string

Retorna dados do solicitante.

Example:

id,name

include[key]

string

Retorna dados da chave.

Example:

id,description,reference

include[country]

string

Retorna o país do solicitante.

Example:

id,name

include[city]

string

Retorna a cidade do solicitante.

Example:

id,name

include[state]

string

Retorna o estado do solicitante.

Example:

id,name

include[district]

string

Retorna o bairro do solicitante.

Example:

id,name

include[image]

string

Retorna a imagem do solicitante.

Example:

file_name

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/keys/keyMovements?sort=id&fields=id%2Cperson_id%2Ctax_id&filter%5Bid%5D=1&filter%5Bkey_id%5D=12&filter%5Bperson_id%5D=12&filter%5Buser_id%5D=123&filter%5Breturned%5D=1&filter%5Btaked_at%5D=20%2F04%2F2021&filter%5Breturned_at%5D=30%2F04%2F2021&filter%5Breturn_prevision%5D=30%2F04%2F2021&filter%5Bperson_name%5D=Rog%C3%A9rio&filter%5Bperson_phone%5D=%2847%29+92860-8431&filter%5Bperson_tax_id%5D=365.277.520-16&filter%5Bperson_zip_code%5D=69316-038&filter%5Bcountry_id%5D=1&filter%5Bstate_id%5D=22&filter%5Bcity_id%5D=7375&filter%5Bdistrict_id%5D=35040&filter%5Bstreet%5D=Rua+Z-Y&filter%5Bnumber%5D=Apartamento&filter%5Bcomplement%5D=Apartamento&filter%5Bnotes%5D=Cliente+%C3%A9+de+outra+cidade&include%5Buser%5D=id%2Cname&include%5Bperson%5D=id%2Cname&include%5Bkey%5D=id%2Cdescription%2Creference&include%5Bcountry%5D=id%2Cname&include%5Bcity%5D=id%2Cname&include%5Bstate%5D=id%2Cname&include%5Bdistrict%5D=id%2Cname&include%5Bimage%5D=file_name" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/buildings/keys/keyMovements';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'sort' => 'id',
            'fields' => 'id,person_id,tax_id',
            'filter[id]' => '1',
            'filter[key_id]' => '12',
            'filter[person_id]' => '12',
            'filter[user_id]' => '123',
            'filter[returned]' => '1',
            'filter[taked_at]' => '20/04/2021',
            'filter[returned_at]' => '30/04/2021',
            'filter[return_prevision]' => '30/04/2021',
            'filter[person_name]' => 'Rogério',
            'filter[person_phone]' => '(47) 92860-8431',
            'filter[person_tax_id]' => '365.277.520-16',
            'filter[person_zip_code]' => '69316-038',
            'filter[country_id]' => '1',
            'filter[state_id]' => '22',
            'filter[city_id]' => '7375',
            'filter[district_id]' => '35040',
            'filter[street]' => 'Rua Z-Y',
            'filter[number]' => 'Apartamento',
            'filter[complement]' => 'Apartamento',
            'filter[notes]' => 'Cliente é de outra cidade',
            'include[user]' => 'id,name',
            'include[person]' => 'id,name',
            'include[key]' => 'id,description,reference',
            'include[country]' => 'id,name',
            'include[city]' => 'id,name',
            'include[state]' => 'id,name',
            'include[district]' => 'id,name',
            'include[image]' => 'file_name',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/buildings/keys/keyMovements

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

key_id

integer

required

ID da chave.

Example:

person_id

integer

ID do solicitante.

Example:

user_id

integer

required

ID do corretor responsável.

Example:

123

returned

boolean

Se a chave foi devolvida.

Example:

taked_at

string

required

Quando a pessoa retirou.

Example:

20/04/2021

returned_at

string

Quando a pessoa devolveu.

Example:

30/04/2021

return_prevision

string

Previsão de devolução.

Example:

30/04/2021

person_name

string

required

Nome do solicitante.

Example:

Rogério

person_phone

string

required

telefone do solicitante.

Example:

(47) 92860-8431

person_tax_id

string

required

CPF do solicitante.

Example:

365.277.520-16

person_zip_code

string

CEP do solicitante.

Example:

69316-038

country_id

integer

ID de País do solicitante.

Example:

state_id

integer

ID de Estado do solicitante.

Example:

city_id

integer

ID de Cidade do solicitante.

Example:

7375

district_id

integer

ID de Bairro do solicitante.

Example:

35040

street

string

Rua do solicitante.

Example:

Rua Z-Y

number

string

Complemento do solicitante.

Example:

Apartamento

complement

string

Complemento do solicitante.

Example:

Apartamento

notes

string

Observações.

Example:

Cliente é de outra cidade

Auth

Bearer

Headers

Body

{ "key_id": 12, "person_id": 12, "user_id": 123, "returned": true, "taked_at": "20\/04\/2021", "returned_at": "30\/04\/2021", "return_prevision": "30\/04\/2021", "person_name": "Rog\u00e9rio", "person_phone": "(47) 92860-8431", "person_tax_id": "365.277.520-16", "person_zip_code": "69316-038", "country_id": 1, "state_id": 22, "city_id": 7375, "district_id": 35040, "street": "Rua Z-Y", "number": "Apartamento", "complement": "Apartamento", "notes": "Cliente \u00e9 de outra cidade" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/buildings/keys/keyMovements" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"key_id\": 12,
    \"person_id\": 12,
    \"user_id\": 123,
    \"returned\": true,
    \"taked_at\": \"20\\/04\\/2021\",
    \"returned_at\": \"30\\/04\\/2021\",
    \"return_prevision\": \"30\\/04\\/2021\",
    \"person_name\": \"Rogério\",
    \"person_phone\": \"(47) 92860-8431\",
    \"person_tax_id\": \"365.277.520-16\",
    \"person_zip_code\": \"69316-038\",
    \"country_id\": 1,
    \"state_id\": 22,
    \"city_id\": 7375,
    \"district_id\": 35040,
    \"street\": \"Rua Z-Y\",
    \"number\": \"Apartamento\",
    \"complement\": \"Apartamento\",
    \"notes\": \"Cliente é de outra cidade\"
}"

Obter

GET

https://api.apresenta.me/buildings/keys/keyMovements/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da Movimentação de Chaves .

Example:

Query Parameters

sort

string

Campo para ordenar os registros.

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta.

Example:

id,person_id,tax_id

include[user]

string

Retorna dados do corretor responsável.

Example:

id,name

include[person]

string

Retorna dados do solicitante.

Example:

id,name

include[key]

string

Retorna dados da chave.

Example:

id,description,reference

include[country]

string

Retorna o país do solicitante.

Example:

id,name

include[city]

string

Retorna a cidade do solicitante.

Example:

id,name

include[state]

string

Retorna o estado do solicitante.

Example:

id,name

include[district]

string

Retorna o bairro do solicitante.

Example:

id,name

include[image]

string

Retorna a imagem do solicitante.

Example:

file_name

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/keys/keyMovements/2?sort=id&fields=id%2Cperson_id%2Ctax_id&include%5Buser%5D=id%2Cname&include%5Bperson%5D=id%2Cname&include%5Bkey%5D=id%2Cdescription%2Creference&include%5Bcountry%5D=id%2Cname&include%5Bcity%5D=id%2Cname&include%5Bstate%5D=id%2Cname&include%5Bdistrict%5D=id%2Cname&include%5Bimage%5D=file_name" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/buildings/keys/keyMovements/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da Movimentação de Chave.

Example:

Body Parameters

key_id

integer

ID da chave.

Example:

person_id

integer

ID do solicitante.

Example:

user_id

integer

ID do corretor responsável.

Example:

123

returned

boolean

Se a chave foi devolvida.

Example:

taked_at

string

Quando a pessoa retirou.

Example:

20/04/2021

returned_at

string

Quando a pessoa devolveu.

Example:

30/04/2021

return_prevision

string

Previsão de devolução.

Example:

30/04/2021

person_name

string

Nome do solicitante.

Example:

Rogério

person_phone

string

telefone do solicitante.

Example:

(47) 92860-8431

person_tax_id

string

CPF do solicitante.

Example:

365.277.520-16

person_zip_code

string

CEP do solicitante.

Example:

69316-038

country_id

integer

ID de País do solicitante.

Example:

state_id

integer

ID de Estado do solicitante.

Example:

city_id

integer

ID de Cidade do solicitante.

Example:

7375

district_id

integer

ID de Bairro do solicitante.

Example:

35040

street

string

Rua do solicitante.

Example:

Rua Z-Y

number

string

Complemento do solicitante.

Example:

Apartamento

complement

string

Complemento do solicitante.

Example:

Apartamento

notes

string

Observações.

Example:

Cliente é de outra cidade

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/buildings/keys/keyMovements/11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"key_id\": 12,
    \"person_id\": 12,
    \"user_id\": 123,
    \"returned\": true,
    \"taked_at\": \"20\\/04\\/2021\",
    \"returned_at\": \"30\\/04\\/2021\",
    \"return_prevision\": \"30\\/04\\/2021\",
    \"person_name\": \"Rogério\",
    \"person_phone\": \"(47) 92860-8431\",
    \"person_tax_id\": \"365.277.520-16\",
    \"person_zip_code\": \"69316-038\",
    \"country_id\": 1,
    \"state_id\": 22,
    \"city_id\": 7375,
    \"district_id\": 35040,
    \"street\": \"Rua Z-Y\",
    \"number\": \"Apartamento\",
    \"complement\": \"Apartamento\",
    \"notes\": \"Cliente é de outra cidade\"
}"

Excluir

DELETE

https://api.apresenta.me/buildings/keys/keyMovements/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da Movimentação de Chave.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/buildings/keys/keyMovements/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Devolver

GET

https://api.apresenta.me/buildings/returnKey/{movement_id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

movement_id

integer

required

ID da Movimentação de Chave.

Example:

Query Parameters

date

string

Data da devolução.

Example:

10/05/2021 11:21:35

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/returnKey/18?date=10%2F05%2F2021+11%3A21%3A35" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Chaves

Pesquisar

GET

https://api.apresenta.me/buildings/keys

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building

integer

ID do imóvel.

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

principal

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,is_with,principal

filter[id]

integer

ID da chave.

Example:

123

filter[building_id]

integer

ID do imóvel.

Example:

11111

filter[reference]

string

Referência da chave.

Example:

CHA01

filter[description]

string

Descrição da chave.

Example:

Chave da Suíte

filter[is_with]

string

Com quem a chave está.

Example:

proprietary

filter[principal]

boolean

Chave principal.

include[building]

string

Retorna os dados do imóvel.

Example:

id,title

include[movements]

string

Retorna as movimentações da chave.

Example:

id,title

include[activeMovements]

string

Retorna as movimentações ativas da chave.

Example:

id,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/keys?sort=principal&fields=id%2Cis_with%2Cprincipal&filter%5Bid%5D=123&filter%5Bbuilding_id%5D=11111&filter%5Breference%5D=CHA01&filter%5Bdescription%5D=Chave+da+Su%C3%ADte&filter%5Bis_with%5D=proprietary&filter%5Bprincipal%5D=&include%5Bbuilding%5D=id%2Ctitle&include%5Bmovements%5D=id%2Ctitle&include%5BactiveMovements%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/buildings/keys

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building

string

id required ID do imóvel.

Example:

Body Parameters

building_id

integer

ID do imóvel.

Example:

11111

reference

string

Referência da chave.

Example:

CHA01

description

string

Descrição da chave.

Example:

Chave da Suíte

is_with

string

Com quem a chave está.

Example:

proprietary

principal

boolean

Chave principal.

Auth

Bearer

Headers

URL Parameters

Body

{ "building_id": 11111, "reference": "CHA01", "description": "Chave da Su\u00edte", "is_with": "proprietary", "principal": false }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/buildings/keys" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"building_id\": 11111,
    \"reference\": \"CHA01\",
    \"description\": \"Chave da Suíte\",
    \"is_with\": \"proprietary\",
    \"principal\": false
}"

Obter

GET

https://api.apresenta.me/buildings/keys/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da Chave.

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

principal

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,is_with,principal

include[building]

string

Retorna os dados do imóvel.

Example:

id,title

include[movements]

string

Retorna as movimentações da chave.

Example:

id,title

include[activeMovements]

string

Retorna as movimentações ativas da chave.

Example:

id,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/keys/2?sort=principal&fields=id%2Cis_with%2Cprincipal&include%5Bbuilding%5D=id%2Ctitle&include%5Bmovements%5D=id%2Ctitle&include%5BactiveMovements%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/buildings/keys/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da chave.

Example:

building

integer

required

ID do imóvel.

Example:

Body Parameters

building_id

integer

ID do imóvel.

Example:

11111

reference

string

Referência da chave.

Example:

CHA01

description

string

Descrição da chave.

Example:

Chave da Suíte

is_with

string

Com quem a chave está.

Example:

proprietary

principal

boolean

Chave principal.

Auth

Bearer

Headers

URL Parameters

Body

{ "building_id": 11111, "reference": "CHA01", "description": "Chave da Su\u00edte", "is_with": "proprietary", "principal": false }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/buildings/keys/15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"building_id\": 11111,
    \"reference\": \"CHA01\",
    \"description\": \"Chave da Suíte\",
    \"is_with\": \"proprietary\",
    \"principal\": false
}"

Excluir

DELETE

https://api.apresenta.me/buildings/keys/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da chave.

Example:

building

integer

required

ID do imóvel.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/buildings/keys/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Detalhes

Pesquisar

GET

https://api.apresenta.me/buildings/details

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros.

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta.

Example:

id,description

filter[id]

integer

ID do detalhe.

Example:

filter[group_id]

integer

ID do detalhe.

Example:

filter[description]

integer

ID do detalhe.

Example:

filter[default]

boolean

Detalhe padrão.

include[group]

string

Retorna os dados do grupo de detalhe.

Example:

id,description

include[buildings]

string

Retorna os imóveis com o detalhe. Exmaple: id,title

Example:

minus

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/details?sort=id&fields=id%2Cdescription&filter%5Bid%5D=1&filter%5Bgroup_id%5D=3&filter%5Bdescription%5D=0&filter%5Bdefault%5D=&include%5Bgroup%5D=id%2Cdescription&include%5Bbuildings%5D=minus" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/buildings/details

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

integer

ID do detalhe.

Example:

group_id

integer

ID do detalhe.

Example:

description

integer

ID do detalhe.

Example:

default

boolean

Detalhe padrão.

Auth

Bearer

Headers

Body

{ "id": 1, "group_id": 3, "description": 0, "default": false }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/buildings/details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 1,
    \"group_id\": 3,
    \"description\": 0,
    \"default\": false
}"

Obter

GET

https://api.apresenta.me/buildings/details/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Detalhe.

Example:

Query Parameters

sort

string

Campo para ordenar os registros.

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta.

Example:

id,description

include[group]

string

Retorna os dados do grupo de detalhe.

Example:

id,description

include[buildings]

string

Retorna os imóveis com o detalhe. Exmaple: id,title

Example:

rerum

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/details/2?sort=id&fields=id%2Cdescription&include%5Bgroup%5D=id%2Cdescription&include%5Bbuildings%5D=rerum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/buildings/details/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Detalhe.

Example:

Body Parameters

integer

ID do detalhe.

Example:

group_id

integer

ID do detalhe.

Example:

description

integer

ID do detalhe.

Example:

default

boolean

Detalhe padrão.

Auth

Bearer

Headers

URL Parameters

Body

{ "id": 1, "group_id": 3, "description": 0, "default": false }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/buildings/details/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 1,
    \"group_id\": 3,
    \"description\": 0,
    \"default\": false
}"

Excluir

DELETE

https://api.apresenta.me/buildings/details/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Detalhe.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/buildings/details/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Grupo de Detalhes

Pesquisar

GET

https://api.apresenta.me/buildings/detailGroups

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description

filter[id]

integer

ID do grupo de detalhe.

Example:

filter[description]

string

Descrição.

Example:

Decorações

include[details]

string

Traz os detalhes do grupo.

Example:

id,description

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/detailGroups?sort=id&fields=id%2Cdescription&filter%5Bid%5D=4&filter%5Bdescription%5D=Decora%C3%A7%C3%B5es&include%5Bdetails%5D=id%2Cdescription" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/buildings/detailGroups

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

description

string

required

Descrição.

Example:

Decorações

Auth

Bearer

Headers

Body

{ "description": "Decora\u00e7\u00f5es" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/buildings/detailGroups" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Decorações\"
}"

Obter

GET

https://api.apresenta.me/buildings/detailGroups/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Grupo de Detalhe

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,description

include[details]

string

Traz os detalhes do grupo.

Example:

id,description

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/detailGroups/5?sort=id&fields=id%2Cdescription&include%5Bdetails%5D=id%2Cdescription" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/buildings/detailGroups/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

ID do grupo de detalhe.

Example:

Body Parameters

description

string

Descrição.

Example:

Decorações

Auth

Bearer

Headers

URL Parameters

Body

{ "description": "Decora\u00e7\u00f5es" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/buildings/detailGroups/5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Decorações\"
}"

Excluir

DELETE

https://api.apresenta.me/buildings/detailGroups/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

ID do grupo de detalhe.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/buildings/detailGroups/9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Aprovar

PUT

https://api.apresenta.me/buildings/approve/{building_id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do imóvel

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/buildings/approve/11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Duplicar

POST

https://api.apresenta.me/buildings/{building_id}/duplicate

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

building_id

integer

required

ID do Imóvel

Example:

Body Parameters

medias

boolean

Define se duplica as mídias do imóvel

Example:

keys

boolean

Define se duplica as chaves do imóvel

season_packs

boolean

Define se duplica os pacotes de temporada

unavailable_dates

boolean

Define se duplica os dias indisponíveis

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "medias": true, "keys": false, "season_packs": false, "unavailable_dates": true }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/buildings/16/duplicate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"medias\": true,
    \"keys\": false,
    \"season_packs\": false,
    \"unavailable_dates\": true
}"

Executa agentes de IA em massa sobre imóveis (dispara Job).

POST

https://api.apresenta.me/buildings/ai/massRun

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/buildings/ai/massRun" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Pesquisar

GET

https://api.apresenta.me/buildings

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,title,slug,type_id

filter[id]

integer

ID do imóvel.

Example:

filter[id2]

integer

ID visível do imóvel.

Example:

filter[condominium_id]

integer

ID do condomínio.

Example:

filter[reference]

string

Referência.

Example:

CA001

filter[status]

string

Status.

Example:

active

filter[lock]

string

Bloqueio do imóvel.

Example:

free

filter[type_id]

integer

ID do Tipo do imóvel.

Example:

filter[stage_id]

integer

ID do estágio.

Example:

filter[country_id]

integer

ID do País.

Example:

filter[state_id]

integer

ID do estado.

Example:

filter[city_id]

integer

ID da cidade.

Example:

8650

filter[district_id]

integer

ID do bairro.

Example:

filter[tags]

integer[]

Tags do imóvel.

Example:

[1,2]

filter[responsible]

integer[]

IDs dos responsáveis.

Example:

[1]

filter[constructor_id]

integer

ID da construtora.

Example:

filter[access]

string

Tipo de Acesso.

Example:

all

filter[pickup]

integer

ID do usuário que captou o imóvel.

Example:

123

filter[slug]

string

Link permanente para site.

Example:

exemplo-perma-link

filter[expiration]

boolean

Expiração do imóvel ativa.

filter[expiration_date]

string

Data da expiração do imóvel.

Example:

2024-03-20

filter[active]

boolean

Imóvel Ativo.

Example:

filter[import_id]

string

Referência do sistema externo.

Example:

CA001

filter[principal_media]

string

Mídia principal.

Example:

https://...

filter[purpose_featured]

string

Finalidade em destaque.

Example:

rent

filter[position]

integer

Ordem do imóvel.

Example:

filter[occupancy]

string

Ocupação do imóvel.

Example:

vacant

filter[garage_min]

integer

Quantidade mínima de garagens.

Example:

filter[garage_max]

integer

Quantidade máxima de garagens.

Example:

filter[garage_number]

integer

Número da Vaga.

Example:

123

filter[suite_min]

integer

Quantidade mínima de Suítes.

Example:

filter[suite_max]

integer

Quantidade máxima de Suítes.

Example:

filter[room_min]

integer

Quantidade mínima de Salas.

Example:

filter[room_max]

integer

Quantidade máxima de Salas.

Example:

filter[bathroom_min]

integer

Quantidade mínima de Banheiros.

Example:

filter[bathroom_max]

integer

Quantidade máxima de Banheiros.

Example:

filter[bedroom_min]

integer

Quantidade mínima de Quartos.

Example:

filter[bedroom_max]

integer

Quantidade máxima de Quartos.

Example:

filter[conservation]

string

Conservação do imóvel.

Example:

Bem conservado

filter[built_year]

integer

Ano de construção.

Example:

2000

filter[floor]

integer

Andar do imóvel.

Example:

filter[total_floors]

integer

Quantidade de Andares.

Example:

filter[total_by_floors]

integer

Apartamentos por Andar.

Example:

filter[blocks]

integer

Quantidade de Blocos do condomínio.

Example:

filter[accommodates]

integer

Quantidade de Pessoas que acomoda.

Example:

filter[furnishing]

string

Status da mobília.

Example:

furnished

filter[title]

string

Titulo do imóvel.

Example:

Título Exemplar

filter[plate]

string

Status da placa.

Example:

without

filter[content]

string

HTML de Descrição do imóvel.

Example:

Imóvel de Exemplo!

filter[lock_description]

string

Observações do bloqueio.

Example:

Fim da Locação

filter[area_total_min]

string

numeric Área total mínima.

Example:

123

filter[area_total_max]

string

numeric Área total máxima.

Example:

321

filter[area_private_min]

string

numeric Área privada mínima.

Example:

123

filter[area_private_max]

string

numeric Área privada máxima.

Example:

321

filter[area_useful_min]

string

numeric Área útil mínima.

Example:

123

filter[area_useful_max]

string

numeric Área útil máxima.

Example:

321

filter[area_ground]

string

numeric Área do terreno.

Example:

filter[area_front]

string

numeric Frente do imóvel.

Example:

filter[area_length]

string

numeric Comprimento do imóvel.

Example:

132

filter[area_back]

string

numeric Fundos do imóvel.

Example:

123

filter[street]

string

Rua do imóvel.

Example:

Rua Guanabara

filter[number]

integer

número do imóvel.

Example:

filter[complement]

string

Complemento do imóvel.

Example:

Apartamento

filter[reference_point]

string

Ponto de referência.

Example:

Bar do Seu Zé

filter[building_name]

string

Nome do empreendimento.

Example:

Guanabara Prime

filter[zip_code]

integer

CEP do imóvel.

Example:

89160000

filter[amount_updated_at]

string

Date Data de Atualização dos valores.

Example:

2024-01-01

filter[delivery_date]

string

Date Data de entrega.

Example:

2024-05-01

filter[show_address]

boolean

Divulga Endereço.

Example:

filter[show_number]

boolean

Divulga Número.

Example:

filter[show_complement]

boolean

Divulga Complemento.

Example:

filter[map]

boolean

Divulga Mapa.

filter[map_street]

boolean

Divulga Mapa da Rua.

filter[map_info]

string[]

Infos do mapa.

Example:

[]

filter[map_around]

boolean

Ofuscar ponto exato no mapa.

filter[iptu_reference]

string

Inscrição de IPTU.

Example:

12321321

filter[energy_reference]

string

Matrícula de inscrição de Energia.

Example:

12321313

filter[water_reference]

string

Matrícula de inscrição de Água.

Example:

213213

filter[gas_reference]

string

Matrícula de inscrição de gás.

Example:

23213213-12

filter[incorporation_reference]

string

Inscrição de Incorporação.

Example:

213213123.223

filter[notes]

string

Observações.

Example:

Observações do imóvel

filter[virtual_tour]

string

Link do Tour Virtual.

Example:

https://...

filter[html_title]

string

Título da página (HTML title).

Example:

SEO Título

filter[html_keyword]

string

Palavras Chave (HTML Keyword). Example:

Example:

blanditiis

filter[html_description]

string

descrição SEO.

Example:

SEO,chave

filter[system_featured]

boolean

Destaque no Site.

Example:

filter[thirdparty_featured]

string

Destaque nos Portais.

Example:

disabled

filter[uses_calendar]

string

Uso do calendário.

Example:

disabled

filter[watermark]

boolean

Usa Marca d'água.

Example:

filter[exclusivity]

boolean

Exclusividade.

filter[head_code]

string

Códigos para Plugins Específicos dentro da tag Head.

Example:

function example(foo,bar){...}

filter[status_bar]

boolean

Barra de Status ativa.

filter[status_bar_content]

string

Conteúdo da Barra de Status.

Example:

Sem conteúdo

filter[status_bar_color]

string

Cor da Barra de Status.

Example:

ff00fa

filter[owner_report]

boolean

Notificação para o Proprietário.

Example:

include[purposes]

string

Retorna os dados das finalidades do imóvel.

Example:

type,amount

include[contracts]

string

Retorna os dados de contratos do imóvel.

Example:

type,status

include[rentActive]

string

Retorna contrato de locação ativo/reservado.

Example:

type,example

include[details]

string

Retorna os dados dos detalhes do imóvel.

Example:

id,description

include[tabs]

string

Retorna os dados das abas do imóvel.

Example:

id,tlte

include[keys]

string

Retorna os dados das chaves do imóvel.

Example:

id,reference

include[seasonPacks]

string

Retorna os pacotes de temporadas do imóvel.

Example:

id,description

include[unavailableDates]

string

Retorna as datas indisponíveis do imóvel.

Example:

id,date

include[tickets]

string

Retorna os tickets abertos para o imóvel.

Example:

id,title,notes

include[inspects]

string

Retorna as vistorias do imóvel.

Example:

id,type,status

include[constructor]

string

Retorna a construtora.

Example:

id,name

include[type]

string

Retorna os dados do tipo do imóvel.

Example:

id,description

include[category]

string

Retorna os dados da categoria do imóvel.

Example:

id,description

include[stage]

string

Retorna os dados do estágio do imóvel.

Example:

id,description

include[catcher]

string

Retorna os dados dos corretores captadores do imóvel.

Example:

id,name

include[responsibles]

string

Retorna os dados dos corretores responsáveis do imóvel.

Example:

id,name

include[responsibleGroups]

string

Retorna os dados dos corretores responsáveis do imóvel.

Example:

id,name

include[owners]

string

Retorna os dados dos proprietários dos imóveis.

Example:

id,name

include[ownersPivot]

string

Retorna os dados de distribuição de renda dos proprietários.

Example:

person_id,percentage,principal

include[country]

string

Retorna o País do imóvel.

Example:

id,name

include[city]

string

Retorna a Cidade do imóvel.

Example:

id,name

include[state]

string

Retorna o Estado do imóvel.

Example:

id,name

include[district]

string

Retorna o Bairro do imóvel.

Example:

id,name

include[principal]

string

Retorna a imagem principal do imóvel.

Example:

file_name

include[enterprise]

string

Retorna as imagens do Empreendimento.

Example:

file_name

include[images]

string

Retorna a galeria de imagens do imóvel.

Example:

file_name

include[plants]

string

Retorna galeria de imagens de plantas do imóvel.

Example:

file_name

include[documents]

string

Retorna os documentos públicos do imóvel.

Example:

file_name

include[files]

string

Retorna os documentos do imóvel restritos à imobiliária.

Example:

file_name

include[condominium]

string

Retorna os dados do condomínio.

Example:

id,title

include[tags]

string

Retorna as Tags do imóvel. Example:

Example:

dicta

include[deals]

string

Retorna os negócios com o imóvel.

Example:

id,title

include[events]

string

Retorna os eventos para o imóvel.

Example:

id,type

include[leads]

string

Retorna os leads desse imóvel.

Example:

id,name,phone,email

include[proposals]

string

Retorna as propostas feitas para o imóvel. Example:

Example:

eligendi

include[proposalsActive]

string

Retorna os dados das propostas pendentes ou aceitas do imóvel.

Example:

id,notes,status

include[proposalAccepted]

string

Retorna os dados das propostas aceitas do imóvel.

Example:

id,notes,deal_id

include[exchangeStage]

string

Retorna os estágios de imóvel (radar de permuta).

Example:

id,description

include[exchangeType]

string

Retorna os tipos de imóvel (radar de permuta).

Example:

id,description

include[exchangeDetails]

string

Retorna os detalhes(radar de permuta).

Example:

id,description

include[exchangeCity]

string

Retorna as cidades (radar de permuta).

Example:

id,name

include[exchangeDistrict]

string

Retorna os bairros (radar de permuta).

Example:

id,name,abbreviation

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings?sort=id&fields=id%2Ctitle%2Cslug%2Ctype_id&filter%5Bid%5D=1&filter%5Bid2%5D=11&filter%5Bcondominium_id%5D=13&filter%5Breference%5D=CA001&filter%5Bstatus%5D=active&filter%5Block%5D=free&filter%5Btype_id%5D=1&filter%5Bstage_id%5D=2&filter%5Bcountry_id%5D=1&filter%5Bstate_id%5D=24&filter%5Bcity_id%5D=8650&filter%5Bdistrict_id%5D=1&filter%5Btags%5D[]=1&filter%5Btags%5D[]=2&filter%5Bresponsible%5D[]=1&filter%5Bconstructor_id%5D=1&filter%5Baccess%5D=all&filter%5Bpickup%5D=123&filter%5Bslug%5D=exemplo-perma-link&filter%5Bexpiration%5D=&filter%5Bexpiration_date%5D=2024-03-20&filter%5Bactive%5D=1&filter%5Bimport_id%5D=CA001&filter%5Bprincipal_media%5D=https%3A%2F%2F...&filter%5Bpurpose_featured%5D=rent&filter%5Bposition%5D=1&filter%5Boccupancy%5D=vacant&filter%5Bgarage_min%5D=1&filter%5Bgarage_max%5D=1&filter%5Bgarage_number%5D=123&filter%5Bsuite_min%5D=1&filter%5Bsuite_max%5D=1&filter%5Broom_min%5D=1&filter%5Broom_max%5D=2&filter%5Bbathroom_min%5D=1&filter%5Bbathroom_max%5D=3&filter%5Bbedroom_min%5D=3&filter%5Bbedroom_max%5D=3&filter%5Bconservation%5D=Bem+conservado&filter%5Bbuilt_year%5D=2000&filter%5Bfloor%5D=2&filter%5Btotal_floors%5D=4&filter%5Btotal_by_floors%5D=2&filter%5Bblocks%5D=2&filter%5Baccommodates%5D=5&filter%5Bfurnishing%5D=furnished&filter%5Btitle%5D=T%C3%ADtulo+Exemplar&filter%5Bplate%5D=without&filter%5Bcontent%5D=%3Cp%3EIm%C3%B3vel+de+Exemplo%21%3C%2Fp%3E&filter%5Block_description%5D=Fim+da+Loca%C3%A7%C3%A3o&filter%5Barea_total_min%5D=123&filter%5Barea_total_max%5D=321&filter%5Barea_private_min%5D=123&filter%5Barea_private_max%5D=321&filter%5Barea_useful_min%5D=123&filter%5Barea_useful_max%5D=321&filter%5Barea_ground%5D=12&filter%5Barea_front%5D=21&filter%5Barea_length%5D=132&filter%5Barea_back%5D=123&filter%5Bstreet%5D=Rua+Guanabara&filter%5Bnumber%5D=1&filter%5Bcomplement%5D=Apartamento&filter%5Breference_point%5D=Bar+do+Seu+Z%C3%A9&filter%5Bbuilding_name%5D=Guanabara+Prime&filter%5Bzip_code%5D=89160000&filter%5Bamount_updated_at%5D=2024-01-01&filter%5Bdelivery_date%5D=2024-05-01&filter%5Bshow_address%5D=1&filter%5Bshow_number%5D=1&filter%5Bshow_complement%5D=1&filter%5Bmap%5D=&filter%5Bmap_street%5D=&filter%5Bmap_around%5D=&filter%5Biptu_reference%5D=12321321&filter%5Benergy_reference%5D=12321313&filter%5Bwater_reference%5D=213213&filter%5Bgas_reference%5D=23213213-12&filter%5Bincorporation_reference%5D=213213123.223&filter%5Bnotes%5D=Observa%C3%A7%C3%B5es+do+im%C3%B3vel&filter%5Bvirtual_tour%5D=https%3A%2F%2F...&filter%5Bhtml_title%5D=SEO+T%C3%ADtulo&filter%5Bhtml_keyword%5D=blanditiis&filter%5Bhtml_description%5D=SEO%2Cchave&filter%5Bsystem_featured%5D=1&filter%5Bthirdparty_featured%5D=disabled&filter%5Buses_calendar%5D=disabled&filter%5Bwatermark%5D=1&filter%5Bexclusivity%5D=&filter%5Bhead_code%5D=function+example%28foo%2Cbar%29%7B...%7D&filter%5Bstatus_bar%5D=&filter%5Bstatus_bar_content%5D=Sem+conte%C3%BAdo&filter%5Bstatus_bar_color%5D=ff00fa&filter%5Bowner_report%5D=1&include%5Bpurposes%5D=type%2Camount&include%5Bcontracts%5D=type%2Cstatus&include%5BrentActive%5D=type%2Cexample&include%5Bdetails%5D=id%2Cdescription&include%5Btabs%5D=id%2Ctlte&include%5Bkeys%5D=id%2Creference&include%5BseasonPacks%5D=id%2Cdescription&include%5BunavailableDates%5D=id%2Cdate&include%5Btickets%5D=id%2Ctitle%2Cnotes&include%5Binspects%5D=id%2Ctype%2Cstatus&include%5Bconstructor%5D=id%2Cname&include%5Btype%5D=id%2Cdescription&include%5Bcategory%5D=id%2Cdescription&include%5Bstage%5D=id%2Cdescription&include%5Bcatcher%5D=id%2Cname&include%5Bresponsibles%5D=id%2Cname&include%5BresponsibleGroups%5D=id%2Cname&include%5Bowners%5D=id%2Cname&include%5BownersPivot%5D=person_id%2Cpercentage%2Cprincipal&include%5Bcountry%5D=id%2Cname&include%5Bcity%5D=id%2Cname&include%5Bstate%5D=id%2Cname&include%5Bdistrict%5D=id%2Cname&include%5Bprincipal%5D=file_name&include%5Benterprise%5D=file_name&include%5Bimages%5D=file_name&include%5Bplants%5D=file_name&include%5Bdocuments%5D=file_name&include%5Bfiles%5D=file_name&include%5Bcondominium%5D=id%2Ctitle&include%5Btags%5D=dicta&include%5Bdeals%5D=id%2Ctitle&include%5Bevents%5D=id%2Ctype&include%5Bleads%5D=id%2Cname%2Cphone%2Cemail&include%5Bproposals%5D=eligendi&include%5BproposalsActive%5D=id%2Cnotes%2Cstatus&include%5BproposalAccepted%5D=id%2Cnotes%2Cdeal_id&include%5BexchangeStage%5D=id%2Cdescription&include%5BexchangeType%5D=id%2Cdescription&include%5BexchangeDetails%5D=id%2Cdescription&include%5BexchangeCity%5D=id%2Cname&include%5BexchangeDistrict%5D=id%2Cname%2Cabbreviation" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.apresenta.me/buildings"
);

const params = {
    "sort": "id",
    "fields": "id,title,slug,type_id",
    "filter[id]": "1",
    "filter[id2]": "11",
    "filter[condominium_id]": "13",
    "filter[reference]": "CA001",
    "filter[status]": "active",
    "filter[lock]": "free",
    "filter[type_id]": "1",
    "filter[stage_id]": "2",
    "filter[country_id]": "1",
    "filter[state_id]": "24",
    "filter[city_id]": "8650",
    "filter[district_id]": "1",
    "filter[tags][0]": "1",
    "filter[tags][1]": "2",
    "filter[responsible][0]": "1",
    "filter[constructor_id]": "1",
    "filter[access]": "all",
    "filter[pickup]": "123",
    "filter[slug]": "exemplo-perma-link",
    "filter[expiration]": "0",
    "filter[expiration_date]": "2024-03-20",
    "filter[active]": "1",
    "filter[import_id]": "CA001",
    "filter[principal_media]": "https://...",
    "filter[purpose_featured]": "rent",
    "filter[position]": "1",
    "filter[occupancy]": "vacant",
    "filter[garage_min]": "1",
    "filter[garage_max]": "1",
    "filter[garage_number]": "123",
    "filter[suite_min]": "1",
    "filter[suite_max]": "1",
    "filter[room_min]": "1",
    "filter[room_max]": "2",
    "filter[bathroom_min]": "1",
    "filter[bathroom_max]": "3",
    "filter[bedroom_min]": "3",
    "filter[bedroom_max]": "3",
    "filter[conservation]": "Bem conservado",
    "filter[built_year]": "2000",
    "filter[floor]": "2",
    "filter[total_floors]": "4",
    "filter[total_by_floors]": "2",
    "filter[blocks]": "2",
    "filter[accommodates]": "5",
    "filter[furnishing]": "furnished",
    "filter[title]": "Título Exemplar",
    "filter[plate]": "without",
    "filter[content]": "<p>Imóvel de Exemplo!</p>",
    "filter[lock_description]": "Fim da Locação",
    "filter[area_total_min]": "123",
    "filter[area_total_max]": "321",
    "filter[area_private_min]": "123",
    "filter[area_private_max]": "321",
    "filter[area_useful_min]": "123",
    "filter[area_useful_max]": "321",
    "filter[area_ground]": "12",
    "filter[area_front]": "21",
    "filter[area_length]": "132",
    "filter[area_back]": "123",
    "filter[street]": "Rua Guanabara",
    "filter[number]": "1",
    "filter[complement]": "Apartamento",
    "filter[reference_point]": "Bar do Seu Zé",
    "filter[building_name]": "Guanabara Prime",
    "filter[zip_code]": "89160000",
    "filter[amount_updated_at]": "2024-01-01",
    "filter[delivery_date]": "2024-05-01",
    "filter[show_address]": "1",
    "filter[show_number]": "1",
    "filter[show_complement]": "1",
    "filter[map]": "0",
    "filter[map_street]": "0",
    "filter[map_around]": "0",
    "filter[iptu_reference]": "12321321",
    "filter[energy_reference]": "12321313",
    "filter[water_reference]": "213213",
    "filter[gas_reference]": "23213213-12",
    "filter[incorporation_reference]": "213213123.223",
    "filter[notes]": "Observações do imóvel",
    "filter[virtual_tour]": "https://...",
    "filter[html_title]": "SEO Título",
    "filter[html_keyword]": "blanditiis",
    "filter[html_description]": "SEO,chave",
    "filter[system_featured]": "1",
    "filter[thirdparty_featured]": "disabled",
    "filter[uses_calendar]": "disabled",
    "filter[watermark]": "1",
    "filter[exclusivity]": "0",
    "filter[head_code]": "function example(foo,bar){...}",
    "filter[status_bar]": "0",
    "filter[status_bar_content]": "Sem conteúdo",
    "filter[status_bar_color]": "ff00fa",
    "filter[owner_report]": "1",
    "include[purposes]": "type,amount",
    "include[contracts]": "type,status",
    "include[rentActive]": "type,example",
    "include[details]": "id,description",
    "include[tabs]": "id,tlte",
    "include[keys]": "id,reference",
    "include[seasonPacks]": "id,description",
    "include[unavailableDates]": "id,date",
    "include[tickets]": "id,title,notes",
    "include[inspects]": "id,type,status",
    "include[constructor]": "id,name",
    "include[type]": "id,description",
    "include[category]": "id,description",
    "include[stage]": "id,description",
    "include[catcher]": "id,name",
    "include[responsibles]": "id,name",
    "include[responsibleGroups]": "id,name",
    "include[owners]": "id,name",
    "include[ownersPivot]": "person_id,percentage,principal",
    "include[country]": "id,name",
    "include[city]": "id,name",
    "include[state]": "id,name",
    "include[district]": "id,name",
    "include[principal]": "file_name",
    "include[enterprise]": "file_name",
    "include[images]": "file_name",
    "include[plants]": "file_name",
    "include[documents]": "file_name",
    "include[files]": "file_name",
    "include[condominium]": "id,title",
    "include[tags]": "dicta",
    "include[deals]": "id,title",
    "include[events]": "id,type",
    "include[leads]": "id,name,phone,email",
    "include[proposals]": "eligendi",
    "include[proposalsActive]": "id,notes,status",
    "include[proposalAccepted]": "id,notes,deal_id",
    "include[exchangeStage]": "id,description",
    "include[exchangeType]": "id,description",
    "include[exchangeDetails]": "id,description",
    "include[exchangeCity]": "id,name",
    "include[exchangeDistrict]": "id,name,abbreviation",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/buildings';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'sort' => 'id',
            'fields' => 'id,title,slug,type_id',
            'filter[id]' => '1',
            'filter[id2]' => '11',
            'filter[condominium_id]' => '13',
            'filter[reference]' => 'CA001',
            'filter[status]' => 'active',
            'filter[lock]' => 'free',
            'filter[type_id]' => '1',
            'filter[stage_id]' => '2',
            'filter[country_id]' => '1',
            'filter[state_id]' => '24',
            'filter[city_id]' => '8650',
            'filter[district_id]' => '1',
            'filter[tags][0]' => '1',
            'filter[tags][1]' => '2',
            'filter[responsible][0]' => '1',
            'filter[constructor_id]' => '1',
            'filter[access]' => 'all',
            'filter[pickup]' => '123',
            'filter[slug]' => 'exemplo-perma-link',
            'filter[expiration]' => '0',
            'filter[expiration_date]' => '2024-03-20',
            'filter[active]' => '1',
            'filter[import_id]' => 'CA001',
            'filter[principal_media]' => 'https://...',
            'filter[purpose_featured]' => 'rent',
            'filter[position]' => '1',
            'filter[occupancy]' => 'vacant',
            'filter[garage_min]' => '1',
            'filter[garage_max]' => '1',
            'filter[garage_number]' => '123',
            'filter[suite_min]' => '1',
            'filter[suite_max]' => '1',
            'filter[room_min]' => '1',
            'filter[room_max]' => '2',
            'filter[bathroom_min]' => '1',
            'filter[bathroom_max]' => '3',
            'filter[bedroom_min]' => '3',
            'filter[bedroom_max]' => '3',
            'filter[conservation]' => 'Bem conservado',
            'filter[built_year]' => '2000',
            'filter[floor]' => '2',
            'filter[total_floors]' => '4',
            'filter[total_by_floors]' => '2',
            'filter[blocks]' => '2',
            'filter[accommodates]' => '5',
            'filter[furnishing]' => 'furnished',
            'filter[title]' => 'Título Exemplar',
            'filter[plate]' => 'without',
            'filter[content]' => '<p>Imóvel de Exemplo!</p>',
            'filter[lock_description]' => 'Fim da Locação',
            'filter[area_total_min]' => '123',
            'filter[area_total_max]' => '321',
            'filter[area_private_min]' => '123',
            'filter[area_private_max]' => '321',
            'filter[area_useful_min]' => '123',
            'filter[area_useful_max]' => '321',
            'filter[area_ground]' => '12',
            'filter[area_front]' => '21',
            'filter[area_length]' => '132',
            'filter[area_back]' => '123',
            'filter[street]' => 'Rua Guanabara',
            'filter[number]' => '1',
            'filter[complement]' => 'Apartamento',
            'filter[reference_point]' => 'Bar do Seu Zé',
            'filter[building_name]' => 'Guanabara Prime',
            'filter[zip_code]' => '89160000',
            'filter[amount_updated_at]' => '2024-01-01',
            'filter[delivery_date]' => '2024-05-01',
            'filter[show_address]' => '1',
            'filter[show_number]' => '1',
            'filter[show_complement]' => '1',
            'filter[map]' => '0',
            'filter[map_street]' => '0',
            'filter[map_around]' => '0',
            'filter[iptu_reference]' => '12321321',
            'filter[energy_reference]' => '12321313',
            'filter[water_reference]' => '213213',
            'filter[gas_reference]' => '23213213-12',
            'filter[incorporation_reference]' => '213213123.223',
            'filter[notes]' => 'Observações do imóvel',
            'filter[virtual_tour]' => 'https://...',
            'filter[html_title]' => 'SEO Título',
            'filter[html_keyword]' => 'blanditiis',
            'filter[html_description]' => 'SEO,chave',
            'filter[system_featured]' => '1',
            'filter[thirdparty_featured]' => 'disabled',
            'filter[uses_calendar]' => 'disabled',
            'filter[watermark]' => '1',
            'filter[exclusivity]' => '0',
            'filter[head_code]' => 'function example(foo,bar){...}',
            'filter[status_bar]' => '0',
            'filter[status_bar_content]' => 'Sem conteúdo',
            'filter[status_bar_color]' => 'ff00fa',
            'filter[owner_report]' => '1',
            'include[purposes]' => 'type,amount',
            'include[contracts]' => 'type,status',
            'include[rentActive]' => 'type,example',
            'include[details]' => 'id,description',
            'include[tabs]' => 'id,tlte',
            'include[keys]' => 'id,reference',
            'include[seasonPacks]' => 'id,description',
            'include[unavailableDates]' => 'id,date',
            'include[tickets]' => 'id,title,notes',
            'include[inspects]' => 'id,type,status',
            'include[constructor]' => 'id,name',
            'include[type]' => 'id,description',
            'include[category]' => 'id,description',
            'include[stage]' => 'id,description',
            'include[catcher]' => 'id,name',
            'include[responsibles]' => 'id,name',
            'include[responsibleGroups]' => 'id,name',
            'include[owners]' => 'id,name',
            'include[ownersPivot]' => 'person_id,percentage,principal',
            'include[country]' => 'id,name',
            'include[city]' => 'id,name',
            'include[state]' => 'id,name',
            'include[district]' => 'id,name',
            'include[principal]' => 'file_name',
            'include[enterprise]' => 'file_name',
            'include[images]' => 'file_name',
            'include[plants]' => 'file_name',
            'include[documents]' => 'file_name',
            'include[files]' => 'file_name',
            'include[condominium]' => 'id,title',
            'include[tags]' => 'dicta',
            'include[deals]' => 'id,title',
            'include[events]' => 'id,type',
            'include[leads]' => 'id,name,phone,email',
            'include[proposals]' => 'eligendi',
            'include[proposalsActive]' => 'id,notes,status',
            'include[proposalAccepted]' => 'id,notes,deal_id',
            'include[exchangeStage]' => 'id,description',
            'include[exchangeType]' => 'id,description',
            'include[exchangeDetails]' => 'id,description',
            'include[exchangeCity]' => 'id,name',
            'include[exchangeDistrict]' => 'id,name,abbreviation',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.apresenta.me/buildings'
params = {
  'sort': 'id',
  'fields': 'id,title,slug,type_id',
  'filter[id]': '1',
  'filter[id2]': '11',
  'filter[condominium_id]': '13',
  'filter[reference]': 'CA001',
  'filter[status]': 'active',
  'filter[lock]': 'free',
  'filter[type_id]': '1',
  'filter[stage_id]': '2',
  'filter[country_id]': '1',
  'filter[state_id]': '24',
  'filter[city_id]': '8650',
  'filter[district_id]': '1',
  'filter[tags][0]': '1',
  'filter[tags][1]': '2',
  'filter[responsible][0]': '1',
  'filter[constructor_id]': '1',
  'filter[access]': 'all',
  'filter[pickup]': '123',
  'filter[slug]': 'exemplo-perma-link',
  'filter[expiration]': '0',
  'filter[expiration_date]': '2024-03-20',
  'filter[active]': '1',
  'filter[import_id]': 'CA001',
  'filter[principal_media]': 'https://...',
  'filter[purpose_featured]': 'rent',
  'filter[position]': '1',
  'filter[occupancy]': 'vacant',
  'filter[garage_min]': '1',
  'filter[garage_max]': '1',
  'filter[garage_number]': '123',
  'filter[suite_min]': '1',
  'filter[suite_max]': '1',
  'filter[room_min]': '1',
  'filter[room_max]': '2',
  'filter[bathroom_min]': '1',
  'filter[bathroom_max]': '3',
  'filter[bedroom_min]': '3',
  'filter[bedroom_max]': '3',
  'filter[conservation]': 'Bem conservado',
  'filter[built_year]': '2000',
  'filter[floor]': '2',
  'filter[total_floors]': '4',
  'filter[total_by_floors]': '2',
  'filter[blocks]': '2',
  'filter[accommodates]': '5',
  'filter[furnishing]': 'furnished',
  'filter[title]': 'Título Exemplar',
  'filter[plate]': 'without',
  'filter[content]': '<p>Imóvel de Exemplo!</p>',
  'filter[lock_description]': 'Fim da Locação',
  'filter[area_total_min]': '123',
  'filter[area_total_max]': '321',
  'filter[area_private_min]': '123',
  'filter[area_private_max]': '321',
  'filter[area_useful_min]': '123',
  'filter[area_useful_max]': '321',
  'filter[area_ground]': '12',
  'filter[area_front]': '21',
  'filter[area_length]': '132',
  'filter[area_back]': '123',
  'filter[street]': 'Rua Guanabara',
  'filter[number]': '1',
  'filter[complement]': 'Apartamento',
  'filter[reference_point]': 'Bar do Seu Zé',
  'filter[building_name]': 'Guanabara Prime',
  'filter[zip_code]': '89160000',
  'filter[amount_updated_at]': '2024-01-01',
  'filter[delivery_date]': '2024-05-01',
  'filter[show_address]': '1',
  'filter[show_number]': '1',
  'filter[show_complement]': '1',
  'filter[map]': '0',
  'filter[map_street]': '0',
  'filter[map_around]': '0',
  'filter[iptu_reference]': '12321321',
  'filter[energy_reference]': '12321313',
  'filter[water_reference]': '213213',
  'filter[gas_reference]': '23213213-12',
  'filter[incorporation_reference]': '213213123.223',
  'filter[notes]': 'Observações do imóvel',
  'filter[virtual_tour]': 'https://...',
  'filter[html_title]': 'SEO Título',
  'filter[html_keyword]': 'blanditiis',
  'filter[html_description]': 'SEO,chave',
  'filter[system_featured]': '1',
  'filter[thirdparty_featured]': 'disabled',
  'filter[uses_calendar]': 'disabled',
  'filter[watermark]': '1',
  'filter[exclusivity]': '0',
  'filter[head_code]': 'function example(foo,bar){...}',
  'filter[status_bar]': '0',
  'filter[status_bar_content]': 'Sem conteúdo',
  'filter[status_bar_color]': 'ff00fa',
  'filter[owner_report]': '1',
  'include[purposes]': 'type,amount',
  'include[contracts]': 'type,status',
  'include[rentActive]': 'type,example',
  'include[details]': 'id,description',
  'include[tabs]': 'id,tlte',
  'include[keys]': 'id,reference',
  'include[seasonPacks]': 'id,description',
  'include[unavailableDates]': 'id,date',
  'include[tickets]': 'id,title,notes',
  'include[inspects]': 'id,type,status',
  'include[constructor]': 'id,name',
  'include[type]': 'id,description',
  'include[category]': 'id,description',
  'include[stage]': 'id,description',
  'include[catcher]': 'id,name',
  'include[responsibles]': 'id,name',
  'include[responsibleGroups]': 'id,name',
  'include[owners]': 'id,name',
  'include[ownersPivot]': 'person_id,percentage,principal',
  'include[country]': 'id,name',
  'include[city]': 'id,name',
  'include[state]': 'id,name',
  'include[district]': 'id,name',
  'include[principal]': 'file_name',
  'include[enterprise]': 'file_name',
  'include[images]': 'file_name',
  'include[plants]': 'file_name',
  'include[documents]': 'file_name',
  'include[files]': 'file_name',
  'include[condominium]': 'id,title',
  'include[tags]': 'dicta',
  'include[deals]': 'id,title',
  'include[events]': 'id,type',
  'include[leads]': 'id,name,phone,email',
  'include[proposals]': 'eligendi',
  'include[proposalsActive]': 'id,notes,status',
  'include[proposalAccepted]': 'id,notes,deal_id',
  'include[exchangeStage]': 'id,description',
  'include[exchangeType]': 'id,description',
  'include[exchangeDetails]': 'id,description',
  'include[exchangeCity]': 'id,name',
  'include[exchangeDistrict]': 'id,name,abbreviation',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/buildings

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

id2

integer

ID visível do imóvel.

Example:

condominium_id

integer

ID do condomínio.

Example:

reference

string

Referência.

Example:

CA001

status

string

Status.

Example:

active

lock

string

Bloqueio do imóvel.

Example:

free

type_id

integer

required

ID do Tipo do imóvel.

Example:

stage_id

integer

ID do estágio.

Example:

country_id

integer

ID do País.

Example:

state_id

integer

ID do estado.

Example:

city_id

integer

ID da cidade.

Example:

8650

district_id

integer

ID do bairro.

Example:

Obter

GET

https://api.apresenta.me/buildings/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Imóvel

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,title,slug,type_id

include[purposes]

string

Retorna os dados das finalidades do imóvel.

Example:

type,amount

include[contracts]

string

Retorna os dados de contratos do imóvel.

Example:

type,status

include[rentActive]

string

Retorna contrato de locação ativo/reservado.

Example:

type,example

include[details]

string

Retorna os dados dos detalhes do imóvel.

Example:

id,description

include[tabs]

string

Retorna os dados das abas do imóvel.

Example:

id,tlte

include[keys]

string

Retorna os dados das chaves do imóvel.

Example:

id,reference

include[seasonPacks]

string

Retorna os pacotes de temporadas do imóvel.

Example:

id,description

include[unavailableDates]

string

Retorna as datas indisponíveis do imóvel.

Example:

id,date

include[tickets]

string

Retorna os tickets abertos para o imóvel.

Example:

id,title,notes

include[inspects]

string

Retorna as vistorias do imóvel.

Example:

id,type,status

include[constructor]

string

Retorna a construtora.

Example:

id,name

include[type]

string

Retorna os dados do tipo do imóvel.

Example:

id,description

include[category]

string

Retorna os dados da categoria do imóvel.

Example:

id,description

include[stage]

string

Retorna os dados do estágio do imóvel.

Example:

id,description

include[catcher]

string

Retorna os dados dos corretores captadores do imóvel.

Example:

id,name

include[responsibles]

string

Retorna os dados dos corretores responsáveis do imóvel.

Example:

id,name

include[responsibleGroups]

string

Retorna os dados dos corretores responsáveis do imóvel.

Example:

id,name

include[owners]

string

Retorna os dados dos proprietários dos imóveis.

Example:

id,name

include[ownersPivot]

string

Retorna os dados de distribuição de renda dos proprietários.

Example:

person_id,percentage,principal

include[country]

string

Retorna o País do imóvel.

Example:

id,name

include[city]

string

Retorna a Cidade do imóvel.

Example:

id,name

include[state]

string

Retorna o Estado do imóvel.

Example:

id,name

include[district]

string

Retorna o Bairro do imóvel.

Example:

id,name

include[principal]

string

Retorna a imagem principal do imóvel.

Example:

file_name

include[enterprise]

string

Retorna as imagens do Empreendimento.

Example:

file_name

include[images]

string

Retorna a galeria de imagens do imóvel.

Example:

file_name

include[plants]

string

Retorna galeria de imagens de plantas do imóvel.

Example:

file_name

include[documents]

string

Retorna os documentos públicos do imóvel.

Example:

file_name

include[files]

string

Retorna os documentos do imóvel restritos à imobiliária.

Example:

file_name

include[condominium]

string

Retorna os dados do condomínio.

Example:

id,title

include[tags]

string

Retorna as Tags do imóvel. Example:

Example:

praesentium

include[deals]

string

Retorna os negócios com o imóvel.

Example:

id,title

include[events]

string

Retorna os eventos para o imóvel.

Example:

id,type

include[leads]

string

Retorna os leads desse imóvel.

Example:

id,name,phone,email

include[proposals]

string

Retorna as propostas feitas para o imóvel. Example:

Example:

consequatur

include[proposalsActive]

string

Retorna os dados das propostas pendentes ou aceitas do imóvel.

Example:

id,notes,status

include[proposalAccepted]

string

Retorna os dados das propostas aceitas do imóvel.

Example:

id,notes,deal_id

include[exchangeStage]

string

Retorna os estágios de imóvel (radar de permuta).

Example:

id,description

include[exchangeType]

string

Retorna os tipos de imóvel (radar de permuta).

Example:

id,description

include[exchangeDetails]

string

Retorna os detalhes(radar de permuta).

Example:

id,description

include[exchangeCity]

string

Retorna as cidades (radar de permuta).

Example:

id,name

include[exchangeDistrict]

string

Retorna os bairros (radar de permuta).

Example:

id,name,abbreviation

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/buildings/6?sort=id&fields=id%2Ctitle%2Cslug%2Ctype_id&include%5Bpurposes%5D=type%2Camount&include%5Bcontracts%5D=type%2Cstatus&include%5BrentActive%5D=type%2Cexample&include%5Bdetails%5D=id%2Cdescription&include%5Btabs%5D=id%2Ctlte&include%5Bkeys%5D=id%2Creference&include%5BseasonPacks%5D=id%2Cdescription&include%5BunavailableDates%5D=id%2Cdate&include%5Btickets%5D=id%2Ctitle%2Cnotes&include%5Binspects%5D=id%2Ctype%2Cstatus&include%5Bconstructor%5D=id%2Cname&include%5Btype%5D=id%2Cdescription&include%5Bcategory%5D=id%2Cdescription&include%5Bstage%5D=id%2Cdescription&include%5Bcatcher%5D=id%2Cname&include%5Bresponsibles%5D=id%2Cname&include%5BresponsibleGroups%5D=id%2Cname&include%5Bowners%5D=id%2Cname&include%5BownersPivot%5D=person_id%2Cpercentage%2Cprincipal&include%5Bcountry%5D=id%2Cname&include%5Bcity%5D=id%2Cname&include%5Bstate%5D=id%2Cname&include%5Bdistrict%5D=id%2Cname&include%5Bprincipal%5D=file_name&include%5Benterprise%5D=file_name&include%5Bimages%5D=file_name&include%5Bplants%5D=file_name&include%5Bdocuments%5D=file_name&include%5Bfiles%5D=file_name&include%5Bcondominium%5D=id%2Ctitle&include%5Btags%5D=praesentium&include%5Bdeals%5D=id%2Ctitle&include%5Bevents%5D=id%2Ctype&include%5Bleads%5D=id%2Cname%2Cphone%2Cemail&include%5Bproposals%5D=consequatur&include%5BproposalsActive%5D=id%2Cnotes%2Cstatus&include%5BproposalAccepted%5D=id%2Cnotes%2Cdeal_id&include%5BexchangeStage%5D=id%2Cdescription&include%5BexchangeType%5D=id%2Cdescription&include%5BexchangeDetails%5D=id%2Cdescription&include%5BexchangeCity%5D=id%2Cname&include%5BexchangeDistrict%5D=id%2Cname%2Cabbreviation" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.apresenta.me/buildings/6"
);

const params = {
    "sort": "id",
    "fields": "id,title,slug,type_id",
    "include[purposes]": "type,amount",
    "include[contracts]": "type,status",
    "include[rentActive]": "type,example",
    "include[details]": "id,description",
    "include[tabs]": "id,tlte",
    "include[keys]": "id,reference",
    "include[seasonPacks]": "id,description",
    "include[unavailableDates]": "id,date",
    "include[tickets]": "id,title,notes",
    "include[inspects]": "id,type,status",
    "include[constructor]": "id,name",
    "include[type]": "id,description",
    "include[category]": "id,description",
    "include[stage]": "id,description",
    "include[catcher]": "id,name",
    "include[responsibles]": "id,name",
    "include[responsibleGroups]": "id,name",
    "include[owners]": "id,name",
    "include[ownersPivot]": "person_id,percentage,principal",
    "include[country]": "id,name",
    "include[city]": "id,name",
    "include[state]": "id,name",
    "include[district]": "id,name",
    "include[principal]": "file_name",
    "include[enterprise]": "file_name",
    "include[images]": "file_name",
    "include[plants]": "file_name",
    "include[documents]": "file_name",
    "include[files]": "file_name",
    "include[condominium]": "id,title",
    "include[tags]": "praesentium",
    "include[deals]": "id,title",
    "include[events]": "id,type",
    "include[leads]": "id,name,phone,email",
    "include[proposals]": "consequatur",
    "include[proposalsActive]": "id,notes,status",
    "include[proposalAccepted]": "id,notes,deal_id",
    "include[exchangeStage]": "id,description",
    "include[exchangeType]": "id,description",
    "include[exchangeDetails]": "id,description",
    "include[exchangeCity]": "id,name",
    "include[exchangeDistrict]": "id,name,abbreviation",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/buildings/6';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'sort' => 'id',
            'fields' => 'id,title,slug,type_id',
            'include[purposes]' => 'type,amount',
            'include[contracts]' => 'type,status',
            'include[rentActive]' => 'type,example',
            'include[details]' => 'id,description',
            'include[tabs]' => 'id,tlte',
            'include[keys]' => 'id,reference',
            'include[seasonPacks]' => 'id,description',
            'include[unavailableDates]' => 'id,date',
            'include[tickets]' => 'id,title,notes',
            'include[inspects]' => 'id,type,status',
            'include[constructor]' => 'id,name',
            'include[type]' => 'id,description',
            'include[category]' => 'id,description',
            'include[stage]' => 'id,description',
            'include[catcher]' => 'id,name',
            'include[responsibles]' => 'id,name',
            'include[responsibleGroups]' => 'id,name',
            'include[owners]' => 'id,name',
            'include[ownersPivot]' => 'person_id,percentage,principal',
            'include[country]' => 'id,name',
            'include[city]' => 'id,name',
            'include[state]' => 'id,name',
            'include[district]' => 'id,name',
            'include[principal]' => 'file_name',
            'include[enterprise]' => 'file_name',
            'include[images]' => 'file_name',
            'include[plants]' => 'file_name',
            'include[documents]' => 'file_name',
            'include[files]' => 'file_name',
            'include[condominium]' => 'id,title',
            'include[tags]' => 'praesentium',
            'include[deals]' => 'id,title',
            'include[events]' => 'id,type',
            'include[leads]' => 'id,name,phone,email',
            'include[proposals]' => 'consequatur',
            'include[proposalsActive]' => 'id,notes,status',
            'include[proposalAccepted]' => 'id,notes,deal_id',
            'include[exchangeStage]' => 'id,description',
            'include[exchangeType]' => 'id,description',
            'include[exchangeDetails]' => 'id,description',
            'include[exchangeCity]' => 'id,name',
            'include[exchangeDistrict]' => 'id,name,abbreviation',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.apresenta.me/buildings/6'
params = {
  'sort': 'id',
  'fields': 'id,title,slug,type_id',
  'include[purposes]': 'type,amount',
  'include[contracts]': 'type,status',
  'include[rentActive]': 'type,example',
  'include[details]': 'id,description',
  'include[tabs]': 'id,tlte',
  'include[keys]': 'id,reference',
  'include[seasonPacks]': 'id,description',
  'include[unavailableDates]': 'id,date',
  'include[tickets]': 'id,title,notes',
  'include[inspects]': 'id,type,status',
  'include[constructor]': 'id,name',
  'include[type]': 'id,description',
  'include[category]': 'id,description',
  'include[stage]': 'id,description',
  'include[catcher]': 'id,name',
  'include[responsibles]': 'id,name',
  'include[responsibleGroups]': 'id,name',
  'include[owners]': 'id,name',
  'include[ownersPivot]': 'person_id,percentage,principal',
  'include[country]': 'id,name',
  'include[city]': 'id,name',
  'include[state]': 'id,name',
  'include[district]': 'id,name',
  'include[principal]': 'file_name',
  'include[enterprise]': 'file_name',
  'include[images]': 'file_name',
  'include[plants]': 'file_name',
  'include[documents]': 'file_name',
  'include[files]': 'file_name',
  'include[condominium]': 'id,title',
  'include[tags]': 'praesentium',
  'include[deals]': 'id,title',
  'include[events]': 'id,type',
  'include[leads]': 'id,name,phone,email',
  'include[proposals]': 'consequatur',
  'include[proposalsActive]': 'id,notes,status',
  'include[proposalAccepted]': 'id,notes,deal_id',
  'include[exchangeStage]': 'id,description',
  'include[exchangeType]': 'id,description',
  'include[exchangeDetails]': 'id,description',
  'include[exchangeCity]': 'id,name',
  'include[exchangeDistrict]': 'id,name,abbreviation',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/buildings/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Imóvel

Example:

Body Parameters

id2

integer

ID visível do imóvel.

Example:

condominium_id

integer

ID do condomínio.

Example:

reference

string

Referência.

Example:

CA001

status

string

Status.

Example:

active

lock

string

Bloqueio do imóvel.

Example:

free

type_id

integer

ID do Tipo do imóvel.

Example:

stage_id

integer

ID do estágio.

Example:

country_id

integer

ID do País.

Example:

state_id

integer

ID do estado.

Example:

city_id

integer

ID da cidade.

Example:

8650

district_id

integer

ID do bairro.

Example:

Excluir

DELETE

https://api.apresenta.me/buildings/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Imóvel

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/buildings/16" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Leads

Converter Lead para Negócio

POST

https://api.apresenta.me/persons/leads/convert/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do lead

Example:

Body Parameters

funnel_step_id

integer

required

ID da Etapa de Funil

Example:

user

integer

required

Código do usuário responsável pelo Negócio

Example:

notes

string

Histórico adicionado no negócio

Example:

labore

Auth

Bearer

Headers

URL Parameters

Body

{ "funnel_step_id": 20, "user": 8, "notes": "labore" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/persons/leads/convert/7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"funnel_step_id\": 20,
    \"user\": 8,
    \"notes\": \"labore\"
}"

Pesquisar

GET

https://api.apresenta.me/persons/leads

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,phone,email

filter[id]

integer

Filtra por código

Example:

filter[name]

string

Filtra por nome

Example:

%exemplo%

filter[date]

string

Filtra por data do contato

Example:

2024-01-01

filter[email]

string

Filtra por e-mail

Example:

example@mail.com

filter[status]

string

Filtra por status, permitindo: read, 'not-read', 'filed' e 'distribuition'

Example:

read

filter[phone]

string

Filtra por telefone

Example:

999999999

filter[purpose]

string

Filtra por Finalidade, podendo ser: change, rent, sale, season

Example:

rent

filter[building_id]

integer

Filtra por ID do Imóvel

Example:

123456

filter[origin_id]

integer

Filtra por ID de origem

Example:

filter[origin_details]

string

Filtra por detalhe de origem

Example:

%Site%

filter[message]

string

Filtra por mensagem

Example:

Tenho interesse%

filter[notes]

string

Filtra por observações

Example:

Deseja casa no bairro%

filter[ads_campaign]

string

Filtra por ID de campanha ADS

Example:

Cj0KCQiA4L2FFhCvARIsAO0SBdZrTYfubPvY61Sggf1yElI7IXn6YgdOcJqXm0kHXdhLMR0nTlJzyWAaAg5ZEALw_wcB

filter[deal_id]

integer

Filtra por código do negócio vinculado ao lead.

Example:

123

filter[ad_name]

string

Filtra por Nome do anúncio.

Example:

Nome Teste

filter[adset_name]

string

Filtra por Nome do conjunto de anúncio.

Example:

Conjunto Teste

include[origin]

string

Incluir dados da Origem do Lead

Example:

include[building]

string

Incluir dados do Imóvel vinculado

Example:

reference,title

include[deal]

string

Incluir dados da Origem do Lead

Example:

id,title

include[formBuilder]

string

Retorna os dados do formulário dinâmico, caso o lead tenha entrado via formulário dinâmico.

Example:

id,name

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/persons/leads?sort=id&fields=id%2Cname%2Cphone%2Cemail&filter%5Bid%5D=2&filter%5Bname%5D=%25exemplo%25&filter%5Bdate%5D=2024-01-01&filter%5Bemail%5D=example%40mail.com&filter%5Bstatus%5D=read&filter%5Bphone%5D=999999999&filter%5Bpurpose%5D=rent&filter%5Bbuilding_id%5D=123456&filter%5Borigin_id%5D=1&filter%5Borigin_details%5D=%25Site%25&filter%5Bmessage%5D=Tenho+interesse%25&filter%5Bnotes%5D=Deseja+casa+no+bairro%25&filter%5Bads_campaign%5D=Cj0KCQiA4L2FFhCvARIsAO0SBdZrTYfubPvY61Sggf1yElI7IXn6YgdOcJqXm0kHXdhLMR0nTlJzyWAaAg5ZEALw_wcB&filter%5Bdeal_id%5D=123&filter%5Bad_name%5D=Nome+Teste&filter%5Badset_name%5D=Conjunto+Teste&include%5Borigin%5D=id&include%5Bbuilding%5D=reference%2Ctitle&include%5Bdeal%5D=id%2Ctitle&include%5BformBuilder%5D=id%2Cname" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/persons/leads

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Nome do Lead.

Example:

Nome do Lead

string

E-mail do Lead.

Example:

teste@gmail.com

phone

integer

Telefone do Lead.

Example:

47988888888

purpose

string

Finalidade do Lead, podendo ser: change, rent, sale, season.

Example:

sale

building_id

integer

Imóvel que originou o Lead.

Example:

321123

deal_id

integer

Negociação relacionada ao Lead.

Example:

321123

origin_id

integer

ID da Origem.

Example:

origin

string

Origem do lead, caso não saiba o ID.

Example:

Site

message

string

Mensagem.

Example:

Olá de chamo exemplo que gostaria de um....

notes

string

Observações

Example:

Cliente quer imóvel no bairro...

ads_campaign

string

ID de campanha ADS

Example:

Cj0KCQiA4L2BBhCvARIsAO0SBdZrTYfubPvY61Syyf1yElI7IXn6YgdOcJqXm0kHXdhLMR0nTlJzyWAaAg5ZEALw_wcB

ad_name

string

Nome do anúncio.

Example:

Nome Teste

adset_name

string

Nome do conjunto de anúncio.

Example:

Conjunto Teste

notifyUsers

boolean

Define se deve notificar usuários

fields

json

Campos Extras

Example:

{'variavelCampo':{'value': 'valor do campo', 'description': 'nomeCampo', 'value_description': 'descricao do valor'}}

Auth

Bearer

Headers

Body

{ "name": "Nome do Lead", "email": "teste@gmail.com", "phone": 47988888888, "purpose": "sale", "building_id": 321123, "deal_id": 321123, "origin_id": 1, "origin": "Site", "message": "Ol\u00e1 de chamo exemplo que gostaria de um....", "notes": "Cliente quer im\u00f3vel no bairro...", "ads_campaign": "Cj0KCQiA4L2BBhCvARIsAO0SBdZrTYfubPvY61Syyf1yElI7IXn6YgdOcJqXm0kHXdhLMR0nTlJzyWAaAg5ZEALw_wcB", "ad_name": "Nome Teste", "adset_name": "Conjunto Teste", "notifyUsers": false, "fields": "{'variavelCampo':{'value': 'valor do campo', 'description': 'nomeCampo', 'value_description': 'descricao do valor'}}" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/persons/leads" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Nome do Lead\",
    \"email\": \"teste@gmail.com\",
    \"phone\": 47988888888,
    \"purpose\": \"sale\",
    \"building_id\": 321123,
    \"deal_id\": 321123,
    \"origin_id\": 1,
    \"origin\": \"Site\",
    \"message\": \"Olá de chamo exemplo que gostaria de um....\",
    \"notes\": \"Cliente quer imóvel no bairro...\",
    \"ads_campaign\": \"Cj0KCQiA4L2BBhCvARIsAO0SBdZrTYfubPvY61Syyf1yElI7IXn6YgdOcJqXm0kHXdhLMR0nTlJzyWAaAg5ZEALw_wcB\",
    \"ad_name\": \"Nome Teste\",
    \"adset_name\": \"Conjunto Teste\",
    \"notifyUsers\": false,
    \"fields\": \"{\'variavelCampo\':{\'value\': \'valor do campo\', \'description\': \'nomeCampo\', \'value_description\': \'descricao do valor\'}}\"
}"

Obter

GET

https://api.apresenta.me/persons/leads/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do lead

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,phone,email

include[origin]

string

Incluir dados da Origem do Lead

Example:

include[building]

string

Incluir dados do Imóvel vinculado

Example:

reference,title

include[deal]

string

Incluir dados da Origem do Lead

Example:

id,title

include[formBuilder]

string

Retorna os dados do formulário dinâmico, caso o lead tenha entrado via formulário dinâmico.

Example:

id,name

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/persons/leads/3?sort=id&fields=id%2Cname%2Cphone%2Cemail&include%5Borigin%5D=id&include%5Bbuilding%5D=reference%2Ctitle&include%5Bdeal%5D=id%2Ctitle&include%5BformBuilder%5D=id%2Cname" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/persons/leads/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do lead

Example:

Body Parameters

name

string

Nome do Lead.

Example:

Nome do Lead

string

E-mail do Lead.

Example:

teste@gmail.com

phone

integer

Telefone do Lead.

Example:

47988888888

purpose

string

Finalidade do Lead, podendo ser: change, rent, sale, season.

Example:

sale

building_id

integer

Imóvel que originou o Lead.

Example:

321123

deal_id

integer

Negociação relacionada ao Lead.

Example:

321123

origin_id

integer

ID da Origem.

Example:

origin

string

Origem do lead, caso não saiba o ID.

Example:

Site

message

string

Mensagem.

Example:

Olá de chamo exemplo que gostaria de um....

notes

string

Observações

Example:

Cliente quer imóvel no bairro...

ads_campaign

string

ID de campanha ADS

Example:

Cj0KCQiA4L2BBhCvARIsAO0SBdZrTYfubPvY61Syyf1yElI7IXn6YgdOcJqXm0kHXdhLMR0nTlJzyWAaAg5ZEALw_wcB

ad_name

string

Nome do anúncio.

Example:

Nome Teste

adset_name

string

Nome do conjunto de anúncio.

Example:

Conjunto Teste

notifyUsers

boolean

Define se deve notificar usuários

fields

json

Campos Extras

Example:

{'variavelCampo':{'value': 'valor do campo', 'description': 'nomeCampo', 'value_description': 'descricao do valor'}}

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/persons/leads/8" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Nome do Lead\",
    \"email\": \"teste@gmail.com\",
    \"phone\": 47988888888,
    \"purpose\": \"sale\",
    \"building_id\": 321123,
    \"deal_id\": 321123,
    \"origin_id\": 1,
    \"origin\": \"Site\",
    \"message\": \"Olá de chamo exemplo que gostaria de um....\",
    \"notes\": \"Cliente quer imóvel no bairro...\",
    \"ads_campaign\": \"Cj0KCQiA4L2BBhCvARIsAO0SBdZrTYfubPvY61Syyf1yElI7IXn6YgdOcJqXm0kHXdhLMR0nTlJzyWAaAg5ZEALw_wcB\",
    \"ad_name\": \"Nome Teste\",
    \"adset_name\": \"Conjunto Teste\",
    \"notifyUsers\": false,
    \"fields\": \"{\'variavelCampo\':{\'value\': \'valor do campo\', \'description\': \'nomeCampo\', \'value_description\': \'descricao do valor\'}}\"
}"

Excluir

DELETE

https://api.apresenta.me/persons/leads/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do lead

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/persons/leads/19" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Localizações

Países

Pesquisar

GET

https://api.apresenta.me/dependency/locale/country

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,abbreviation

filter[id]

integer

ID do País.

Example:

filter[name]

string

Nome do País.

Example:

Brasil

filter[abbreviation]

string

Código ISO do País.

Example:

include[states]

string

Retorna os estados do país.

Example:

id,name,abbreviation

include[buildings]

string

Retorna os imóveis do país.

Example:

id,title

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/dependency/locale/country?sort=id&fields=id%2Cname%2Cabbreviation&filter%5Bid%5D=1&filter%5Bname%5D=Brasil&filter%5Babbreviation%5D=BR&include%5Bstates%5D=id%2Cname%2Cabbreviation&include%5Bbuildings%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/dependency/locale/country

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Nome do País.

Example:

Brasil

abbreviation

required

string Código ISO do País.

Example:

Auth

Bearer

Headers

Body

{ "name": "Brasil", "abbreviation": "BR" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/dependency/locale/country" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Brasil\",
    \"abbreviation\": \"BR\"
}"

Obter

GET

https://api.apresenta.me/dependency/locale/country/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do País

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,abbreviation

include[states]

string

Retorna os estados do país.

Example:

id,name,abbreviation

include[buildings]

string

Retorna os imóveis do país.

Example:

id,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/dependency/locale/country/19?sort=id&fields=id%2Cname%2Cabbreviation&include%5Bstates%5D=id%2Cname%2Cabbreviation&include%5Bbuildings%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/dependency/locale/country/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do País

Example:

Body Parameters

name

string

Nome do País.

Example:

Brasil

abbreviation

string

Código ISO do País.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "Brasil", "abbreviation": "BR" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/dependency/locale/country/19" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Brasil\",
    \"abbreviation\": \"BR\"
}"

Excluir

DELETE

https://api.apresenta.me/dependency/locale/country/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do País

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/dependency/locale/country/15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Estados

Pesquisar

GET

https://api.apresenta.me/dependency/locale/state

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,abbreviation

filter[id]

integer

Código do estado.

Example:

filter[name]

string

Nome do estado.

Example:

Santa Catarina

filter[abbreviation]

string

Sigla do Estado.

Example:

filter[country_id]

integer

ID do país.

Example:

123

include[cities]

string

Retorna as cidades do estado.

Example:

id,name

include[country]

string

Retorna os dados do país.

Example:

id,name

include[buildings]

string

Retorna os imóveis do estado.

Example:

id,title,slug

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/dependency/locale/state?sort=id&fields=id%2Cname%2Cabbreviation&filter%5Bid%5D=1&filter%5Bname%5D=Santa+Catarina&filter%5Babbreviation%5D=SC&filter%5Bcountry_id%5D=123&include%5Bcities%5D=id%2Cname&include%5Bcountry%5D=id%2Cname&include%5Bbuildings%5D=id%2Ctitle%2Cslug" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/dependency/locale/state

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Nome do Estado.

Example:

Santa Catarina

abbreviation

string

required

Sigla do Estado

Example:

country_id

integer

required

País do Estado

Example:

123

Auth

Bearer

Headers

Body

{ "name": "Santa Catarina", "abbreviation": "SC", "country_id": 123 }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/dependency/locale/state" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Santa Catarina\",
    \"abbreviation\": \"SC\",
    \"country_id\": 123
}"

Obter

GET

https://api.apresenta.me/dependency/locale/state/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Estado

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,abbreviation

include[cities]

string

Retorna as cidades do estado.

Example:

id,name

include[country]

string

Retorna os dados do país.

Example:

id,name

include[buildings]

string

Retorna os imóveis do estado.

Example:

id,title,slug

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/dependency/locale/state/17?sort=id&fields=id%2Cname%2Cabbreviation&include%5Bcities%5D=id%2Cname&include%5Bcountry%5D=id%2Cname&include%5Bbuildings%5D=id%2Ctitle%2Cslug" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/dependency/locale/state/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Estado

Example:

Body Parameters

name

string

Nome do Estado.

Example:

Santa Catarina

abbreviation

string

Sigla do Estado

Example:

country_id

integer

País do Estado

Example:

123

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "Santa Catarina", "abbreviation": "SC", "country_id": 123 }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/dependency/locale/state/8" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Santa Catarina\",
    \"abbreviation\": \"SC\",
    \"country_id\": 123
}"

Excluir

DELETE

https://api.apresenta.me/dependency/locale/state/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Estado

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/dependency/locale/state/15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Cidades

Pesquisar

GET

https://api.apresenta.me/dependency/locale/city

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,state_id

filter[id]

integer

ID da cidade.

Example:

123

filter[name]

string

Nome da cidade.

Example:

Rio do Sul

filter[zip_code]

string

CEP da cidade.

Example:

89160000

filter[ibge]

string

IBGE da cidade.

Example:

1200013

filter[state_id]

integer

Código do Estado.

Example:

321

include[districs]

string

Retorna os bairros da cidade.

Example:

id,name

include[state]

string

Retorna o estado da cidade.

Example:

abbreviation

include[buildings]

string

Retorna os imóveis da cidade.

Example:

id,title

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/dependency/locale/city?sort=id&fields=id%2Cname%2Cstate_id&filter%5Bid%5D=123&filter%5Bname%5D=Rio+do+Sul&filter%5Bzip_code%5D=89160000&filter%5Bibge%5D=1200013&filter%5Bstate_id%5D=321&include%5Bdistrics%5D=id%2Cname&include%5Bstate%5D=abbreviation&include%5Bbuildings%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/dependency/locale/city

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Nome da Cidade.

Example:

Santa Catarina

state_id

integer

required

Estado da Cidade.

Example:

zip_code

string

CEP da Cidade.

Example:

89160000

ibge

string

IBGE da Cidade.

Example:

1200013

Auth

Bearer

Headers

Body

{ "name": "Santa Catarina", "state_id": 1, "zip_code": "89160000", "ibge": "1200013" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/dependency/locale/city" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Santa Catarina\",
    \"state_id\": 1,
    \"zip_code\": \"89160000\",
    \"ibge\": \"1200013\"
}"

Obter

GET

https://api.apresenta.me/dependency/locale/city/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id da Cidade

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,state_id

include[districs]

string

Retorna os bairros da cidade.

Example:

id,name

include[state]

string

Retorna o estado da cidade.

Example:

abbreviation

include[buildings]

string

Retorna os imóveis da cidade.

Example:

id,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/dependency/locale/city/18?sort=id&fields=id%2Cname%2Cstate_id&include%5Bdistrics%5D=id%2Cname&include%5Bstate%5D=abbreviation&include%5Bbuildings%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/dependency/locale/city/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id da Cidade

Example:

Body Parameters

name

string

required

Nome da Cidade.

Example:

Santa Catarina

state_id

integer

required

Estado da Cidade.

Example:

zip_code

string

CEP da Cidade.

Example:

89160000

ibge

string

IBGE da Cidade.

Example:

1200013

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "Santa Catarina", "state_id": 1, "zip_code": "89160000", "ibge": "1200013" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/dependency/locale/city/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Santa Catarina\",
    \"state_id\": 1,
    \"zip_code\": \"89160000\",
    \"ibge\": \"1200013\"
}"

Excluir

DELETE

https://api.apresenta.me/dependency/locale/city/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id da Cidade

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/dependency/locale/city/9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Bairros

Pesquisar

GET

https://api.apresenta.me/dependency/locale/district

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name

filter[id]

integer

Código do bairro.

Example:

123

filter[name]

string

Nome do bairro.

Example:

Centro

filter[city_id]

integer

Cidade do bairro.

Example:

1321

include[city]

string

Retorna a cidade do bairro.

Example:

id,name

include[state]

string

Retorna o estado do bairro.

Example:

id,abbreviation

include[buildings]

string

Retorna os imóveis do bairro.

Example:

id,title

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/dependency/locale/district?sort=id&fields=id%2Cname&filter%5Bid%5D=123&filter%5Bname%5D=Centro&filter%5Bcity_id%5D=1321&include%5Bcity%5D=id%2Cname&include%5Bstate%5D=id%2Cabbreviation&include%5Bbuildings%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/dependency/locale/district

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Nome do Bairro

Example:

Centro

city_id

integer

required

Códido da cidade.

Example:

1233

Auth

Bearer

Headers

Body

{ "name": "Centro", "city_id": 1233 }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/dependency/locale/district" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Centro\",
    \"city_id\": 1233
}"

Obter

GET

https://api.apresenta.me/dependency/locale/district/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Bairro

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name

include[city]

string

Retorna a cidade do bairro.

Example:

id,name

include[state]

string

Retorna o estado do bairro.

Example:

id,abbreviation

include[buildings]

string

Retorna os imóveis do bairro.

Example:

id,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/dependency/locale/district/19?sort=id&fields=id%2Cname&include%5Bcity%5D=id%2Cname&include%5Bstate%5D=id%2Cabbreviation&include%5Bbuildings%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/dependency/locale/district/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Bairro

Example:

Body Parameters

name

string

required

Nome do Bairro

Example:

Centro

city_id

integer

required

Códido

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "Centro", "city_id": 16 }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/dependency/locale/district/14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Centro\",
    \"city_id\": 16
}"

Excluir

DELETE

https://api.apresenta.me/dependency/locale/district/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do Bairro

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/dependency/locale/district/15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Negócios

Etapas do Funil

Pesquisar

GET

https://api.apresenta.me/deals/funnels/steps

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,title

filter[id]

integer

ID Código da Etapa.

Example:

filter[title]

string

Título da Etapa.

Example:

Interesse

filter[funnel_id]

integer

Funil da Etapa.

Example:

filter[position]

integer

Posição da Etapa.

Example:

filter[notes]

string

Descrição da Etapa.

Example:

Etapa para interessados

filter[deadline]

integer

Prazo para Repasse (dias).

Example:

filter[color]

string

Cor da Etapa.

Example:

FF00FA

filter[active]

boolean

Etapa Ativa.

Example:

include[funnel]

string

Retorna o funil.

Example:

id,title

include[deals]

string

Retorna os negócios que estão na etapa.

Example:

id,title

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/deals/funnels/steps?sort=id&fields=id%2Ctitle&filter%5Bid%5D=1&filter%5Btitle%5D=Interesse&filter%5Bfunnel_id%5D=12&filter%5Bposition%5D=2&filter%5Bnotes%5D=Etapa+para+interessados&filter%5Bdeadline%5D=10&filter%5Bcolor%5D=FF00FA&filter%5Bactive%5D=1&include%5Bfunnel%5D=id%2Ctitle&include%5Bdeals%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/deals/funnels/steps

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

title

string

Título da Etapa.

Example:

Interesse

funnel_id

integer

Funil da Etapa.

Example:

position

integer

Posição da Etapa.

Example:

notes

string

Descrição da Etapa.

Example:

Etapa para interessados

deadline

integer

Prazo para Repasse (dias).

Example:

color

string

Cor da Etapa.

Example:

FF00FA

active

boolean

Etapa Ativa.

Example:

Auth

Bearer

Headers

Body

{ "title": "Interesse", "funnel_id": 12, "position": 2, "notes": "Etapa para interessados", "deadline": 10, "color": "FF00FA", "active": true }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/deals/funnels/steps" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Interesse\",
    \"funnel_id\": 12,
    \"position\": 2,
    \"notes\": \"Etapa para interessados\",
    \"deadline\": 10,
    \"color\": \"FF00FA\",
    \"active\": true
}"

Obter

GET

https://api.apresenta.me/deals/funnels/steps/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da Etapa

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,title

include[funnel]

string

Retorna o funil.

Example:

id,title

include[deals]

string

Retorna os negócios que estão na etapa.

Example:

id,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/deals/funnels/steps/6?sort=id&fields=id%2Ctitle&include%5Bfunnel%5D=id%2Ctitle&include%5Bdeals%5D=id%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/deals/funnels/steps/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da Etapa

Example:

Body Parameters

title

string

Título da Etapa.

Example:

Interesse

funnel_id

integer

Funil da Etapa.

Example:

position

integer

Posição da Etapa.

Example:

notes

string

Descrição da Etapa.

Example:

Etapa para interessados

deadline

integer

Prazo para Repasse (dias).

Example:

color

string

Cor da Etapa.

Example:

FF00FA

active

boolean

Etapa Ativa.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "title": "Interesse", "funnel_id": 12, "position": 2, "notes": "Etapa para interessados", "deadline": 10, "color": "FF00FA", "active": true }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/deals/funnels/steps/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Interesse\",
    \"funnel_id\": 12,
    \"position\": 2,
    \"notes\": \"Etapa para interessados\",
    \"deadline\": 10,
    \"color\": \"FF00FA\",
    \"active\": true
}"

Excluir

DELETE

https://api.apresenta.me/deals/funnels/steps/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da Etapa

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/deals/funnels/steps/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Funis

Pesquisar

GET

https://api.apresenta.me/deals/funnels

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,title

filter[id]

integer

ID do Funil.

Example:

filter[title]

string

Título do Funil.

Example:

Funil de Vendas

filter[notes]

string

Descrição do Funil

Example:

dolorem

filter[active]

boolean

Funil Ativo.

Example:

filter[skip]

boolean

Transferir para o próximo corretor.

Example:

filter[responsible]

string[]

Responsávei(s) pelo Funil.

Example:

[3324,5223]

filter[skip_step_change]

boolean

Não altera etapa após limite de dias.

filter[step_id_peal]

integer

Transferir para a etapa do Funil.

Example:

filter[block_step_jump]

boolean

Bloquear pulo de etapa.

include[steps]

string

Etapas do funil.

Example:

id,title

include[responsibles]

string

Responsáveis do Funil.

Example:

id,name

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/deals/funnels?sort=id&fields=id%2Ctitle&filter%5Bid%5D=1&filter%5Btitle%5D=Funil+de+Vendas&filter%5Bnotes%5D=dolorem&filter%5Bactive%5D=1&filter%5Bskip%5D=1&filter%5Bresponsible%5D[]=3324&filter%5Bresponsible%5D[]=5223&filter%5Bskip_step_change%5D=&filter%5Bstep_id_peal%5D=1&filter%5Bblock_step_jump%5D=&include%5Bsteps%5D=id%2Ctitle&include%5Bresponsibles%5D=id%2Cname" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/deals/funnels

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

title

string

required

Título do Funil.

Example:

Funil de Vendas

notes

string

Descrição do Funil

Example:

harum

active

boolean

Funil Ativo.

Example:

skip

boolean

Transferir para o próximo corretor.

Example:

responsible

string[]

required

Responsávei(s) pelo Funil.

Example:

[3324,5223]

skip_step_change

boolean

Não altera etapa após limite de dias.

step_id_peal

integer

Transferir para a etapa do Funil.

Example:

block_step_jump

boolean

Bloquear pulo de etapa.

Auth

Bearer

Headers

Body

{ "title": "Funil de Vendas", "notes": "harum", "active": true, "skip": true, "responsible": [ 3324, 5223 ], "skip_step_change": false, "step_id_peal": 1, "block_step_jump": false }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/deals/funnels" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Funil de Vendas\",
    \"notes\": \"harum\",
    \"active\": true,
    \"skip\": true,
    \"responsible\": [
        3324,
        5223
    ],
    \"skip_step_change\": false,
    \"step_id_peal\": 1,
    \"block_step_jump\": false
}"

Obter

GET

https://api.apresenta.me/deals/funnels/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Funil

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,title

include[steps]

string

Etapas do funil.

Example:

id,title

include[responsibles]

string

Responsáveis do Funil.

Example:

id,name

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/deals/funnels/17?sort=id&fields=id%2Ctitle&include%5Bsteps%5D=id%2Ctitle&include%5Bresponsibles%5D=id%2Cname" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/deals/funnels/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Funil

Example:

Body Parameters

title

string

Título do Funil.

Example:

Funil de Vendas

notes

string

Descrição do Funil

Example:

est

active

boolean

Funil Ativo.

Example:

skip

boolean

Transferir para o próximo corretor.

Example:

responsible

string[]

Responsávei(s) pelo Funil.

Example:

[3324,5223]

skip_step_change

boolean

Não altera etapa após limite de dias.

step_id_peal

integer

Transferir para a etapa do Funil.

Example:

block_step_jump

boolean

Bloquear pulo de etapa.

Auth

Bearer

Headers

URL Parameters

Body

{ "title": "Funil de Vendas", "notes": "est", "active": true, "skip": true, "responsible": [ 3324, 5223 ], "skip_step_change": false, "step_id_peal": 1, "block_step_jump": false }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/deals/funnels/6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Funil de Vendas\",
    \"notes\": \"est\",
    \"active\": true,
    \"skip\": true,
    \"responsible\": [
        3324,
        5223
    ],
    \"skip_step_change\": false,
    \"step_id_peal\": 1,
    \"block_step_jump\": false
}"

Excluir

DELETE

https://api.apresenta.me/deals/funnels/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Funil

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/deals/funnels/6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Confirmar/Rejeitar

POST

https://api.apresenta.me/deals/confirm/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Negócio

Example:

Body Parameters

action

boolean

Confirma ou Rejeita

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "action": true }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/deals/confirm/10" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"action\": true
}"

Aceitar/Negar Lead do Bolsão de Leads

POST

https://api.apresenta.me/deals/acceptLeadCenter/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Negócio

Example:

Body Parameters

action

boolean

Confirma ou Rejeita

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "action": true }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/deals/acceptLeadCenter/14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"action\": true
}"

Pesquisar

GET

https://api.apresenta.me/deals

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,phone,email

filter[title]

string

Título.

Example:

Título do Negócio.

filter[step_id]

integer

Etapa do Negócio.

Example:

filter[step_date]

string

date Data da Etapa do Negócio.

Example:

2022-08-31 00:00:00

filter[status]

string

Status do Negócio.

Example:

won

filter[status_date]

string

date Date do Status do Negócio.

Example:

2022-12-06 10:17:16

filter[type]

string

Tipo do Negócio (Radar).

Example:

sale

filter[responsible]

integer[]

Responsável(s) pelo Negócio.

Example:

[123,456,789]

filter[customer_id]

integer

Cliente do Negócio.

Example:

1234

filter[origin_id]

integer

Origem do Negócio.

Example:

filter[price]

string

Valor do Negócio.

Example:

1500.00

filter[date]

string

date Data do Negócio.

Example:

2020-04-30

filter[forecast]

string

date Data da previsão de finalização do Negócio.

Example:

2020-05-30

filter[potential]

string

Potencial do Negócio. Options: cold, hot, scalding, warm.

Example:

hot

filter[radar]

boolean

Radar Ativo para o Negócio.

filter[private]

boolean

Visibilidade do Negócio.

filter[position]

integer

Posição do negócio (Kanban).

Example:

filter[tag]

integer[]

Tags para o Negócio.

Example:

[1326,1306,1305]

filter[building]

integer[]

Imóveis para o Negócio.

Example:

[13914,15155,15467]

filter[extend]

string

date Prorrogação do Negócio.

Example:

2022-02-21

filter[reason_id]

integer

Motivo do Negócio quando o status é alterado.

Example:

filter[reason_notes]

string

Observações do motivo quando o status do Negócio é alterado.

Example:

Cliente ganho

filter[building_type]

integer[]

Tipos de Imóveis para o Radar de Negócio.

Example:

[5,1,3]

filter[building_stage]

integer[]

Estágio dos Imóveis para o Radar de Negócio.

Example:

[3]

filter[building_furnishing]

string[]

Mobília dos Imóveis para o Radar de Negócio.

filter[building_price_min]

string

Valor mínimo dos Imóveis do Negócio (Radar).

Example:

1500.00

filter[building_price_max]

string

Valor máximo dos Imóveis do Negócio (Radar).

Example:

2500.00

filter[building_bedroom]

integer

Quantidade de quartos para o Radar de Negócio.

Example:

filter[building_living_room]

integer

Quantidade de salas para o Radar de Negócio.

Example:

filter[building_parking]

integer

Quantidade de vagas de estacionamento para o Radar de Negócio.

Example:

filter[building_bathroom]

integer

Quantidade de banheiros para o Radar de Negócio.

Example:

filter[building_area]

integer

Área em metros quadrados para o Radar de Negócio.

Example:

120

filter[building_district]

string

Bairro para o Radar de Negócio.

Example:

filter[building_city]

string

Cidade para o Radar de Negócio.

Example:

filter[building_detail]

integer[]

Detalhes do Imóvel para o Radar de Negócio.

Example:

[9889,29988]

filter[building_check_in]

string

date Check-in do Imóvel para o Radar de Negócio.

Example:

2022-02-21

filter[building_check_out]

string

date Check-out do Imóvel para o Radar de Negócio.

Example:

2022-02-21

filter[building_accommodation]

integer

Quantidade de acomodações do Imóvel para o Radar de Negócio.

Example:

include[tags]

string

Retorna as tags do negócio

Example:

enim

include[notifications]

string

Retorna as notificações do negócio

Example:

quisquam

include[contracts]

string

Retorna os contratos vinculados ao negócio

Example:

aperiam

include[buildings]

string

Retorna os imóveis vinculados ao negócio

Example:

voluptatem

include[responsibles]

string

Retorna os responsáveis do negócio

Example:

ratione

include[creator]

string

Retorna o criador do negócio

Example:

include[customer]

string

Retorna o cliente do negócio

Example:

include[proposals]

string

Retorna as propostas do negócio

Example:

eius

include[activeProposals]

string

Retorna as propostas (pendentes ou aceitas) do negócio.

Example:

dicta

include[leads]

string

Retorna os leads do negócio

Example:

cumque

include[reason]

string

Retorna o motivo do status do negócio.

Example:

id,notes

include[step]

string

Retorna a etapa do negócio.

Example:

id,description

include[files]

string

Retorna os arquivos do negócio.

Example:

id,file_name

include[origin]

string

Retorna a origem do negócio.

Example:

id,name

include[lastHistory]

string

Retorna o último histórico da negociação.

Example:

id,created_at

include[districts]

string

Retorna os bairros dos imóveis (Radar).

Example:

id,name

include[cities]

string

Retorna as cidades dos imóveis (Radar).

Example:

id,name

include[details]

string

Retorna os detalhes dos imóveis (Radar).

Example:

include[buildingTypes]

string

Retorna os tipos dos imóveis (Radar).

Example:

id,name

include[buildingStages]

string

Retorna os estágios dos imóveis (Radar).

Example:

id,name

include[eventsNotConcludedNonRecurring]

string

Retorna eventos não recorrentes que não estão concluídos.

Example:

id,type,title

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/deals?sort=id&fields=id%2Cname%2Cphone%2Cemail&filter%5Btitle%5D=T%C3%ADtulo+do+Neg%C3%B3cio.&filter%5Bstep_id%5D=1&filter%5Bstep_date%5D=2022-08-31+00%3A00%3A00&filter%5Bstatus%5D=won&filter%5Bstatus_date%5D=2022-12-06+10%3A17%3A16&filter%5Btype%5D=sale&filter%5Bresponsible%5D[]=123&filter%5Bresponsible%5D[]=456&filter%5Bresponsible%5D[]=789&filter%5Bcustomer_id%5D=1234&filter%5Borigin_id%5D=9&filter%5Bprice%5D=1500.00&filter%5Bdate%5D=2020-04-30&filter%5Bforecast%5D=2020-05-30&filter%5Bpotential%5D=hot&filter%5Bradar%5D=&filter%5Bprivate%5D=&filter%5Bposition%5D=3&filter%5Btag%5D[]=1326&filter%5Btag%5D[]=1306&filter%5Btag%5D[]=1305&filter%5Bbuilding%5D[]=13914&filter%5Bbuilding%5D[]=15155&filter%5Bbuilding%5D[]=15467&filter%5Bextend%5D=2022-02-21&filter%5Breason_id%5D=1&filter%5Breason_notes%5D=Cliente+ganho&filter%5Bbuilding_type%5D[]=5&filter%5Bbuilding_type%5D[]=1&filter%5Bbuilding_type%5D[]=3&filter%5Bbuilding_stage%5D[]=3&filter%5Bbuilding_furnishing%5D=&filter%5Bbuilding_price_min%5D=1500.00&filter%5Bbuilding_price_max%5D=2500.00&filter%5Bbuilding_bedroom%5D=2&filter%5Bbuilding_living_room%5D=1&filter%5Bbuilding_parking%5D=1&filter%5Bbuilding_bathroom%5D=3&filter%5Bbuilding_area%5D=120&filter%5Bbuilding_district%5D=1&filter%5Bbuilding_city%5D=3&filter%5Bbuilding_detail%5D[]=9889&filter%5Bbuilding_detail%5D[]=29988&filter%5Bbuilding_check_in%5D=2022-02-21&filter%5Bbuilding_check_out%5D=2022-02-21&filter%5Bbuilding_accommodation%5D=4&include%5Btags%5D=enim&include%5Bnotifications%5D=quisquam&include%5Bcontracts%5D=aperiam&include%5Bbuildings%5D=voluptatem&include%5Bresponsibles%5D=ratione&include%5Bcreator%5D=ut&include%5Bcustomer%5D=et&include%5Bproposals%5D=eius&include%5BactiveProposals%5D=dicta&include%5Bleads%5D=cumque&include%5Breason%5D=id%2Cnotes&include%5Bstep%5D=id%2Cdescription&include%5Bfiles%5D=id%2Cfile_name&include%5Borigin%5D=id%2Cname&include%5BlastHistory%5D=id%2Ccreated_at&include%5Bdistricts%5D=id%2Cname&include%5Bcities%5D=id%2Cname&include%5Bdetails%5D=id&include%5BbuildingTypes%5D=id%2Cname&include%5BbuildingStages%5D=id%2Cname&include%5BeventsNotConcludedNonRecurring%5D=id%2Ctype%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.apresenta.me/deals"
);

const params = {
    "sort": "id",
    "fields": "id,name,phone,email",
    "filter[title]": "Título do Negócio.",
    "filter[step_id]": "1",
    "filter[step_date]": "2022-08-31 00:00:00",
    "filter[status]": "won",
    "filter[status_date]": "2022-12-06 10:17:16",
    "filter[type]": "sale",
    "filter[responsible][0]": "123",
    "filter[responsible][1]": "456",
    "filter[responsible][2]": "789",
    "filter[customer_id]": "1234",
    "filter[origin_id]": "9",
    "filter[price]": "1500.00",
    "filter[date]": "2020-04-30",
    "filter[forecast]": "2020-05-30",
    "filter[potential]": "hot",
    "filter[radar]": "0",
    "filter[private]": "0",
    "filter[position]": "3",
    "filter[tag][0]": "1326",
    "filter[tag][1]": "1306",
    "filter[tag][2]": "1305",
    "filter[building][0]": "13914",
    "filter[building][1]": "15155",
    "filter[building][2]": "15467",
    "filter[extend]": "2022-02-21",
    "filter[reason_id]": "1",
    "filter[reason_notes]": "Cliente ganho",
    "filter[building_type][0]": "5",
    "filter[building_type][1]": "1",
    "filter[building_type][2]": "3",
    "filter[building_stage][0]": "3",
    "filter[building_furnishing]": "",
    "filter[building_price_min]": "1500.00",
    "filter[building_price_max]": "2500.00",
    "filter[building_bedroom]": "2",
    "filter[building_living_room]": "1",
    "filter[building_parking]": "1",
    "filter[building_bathroom]": "3",
    "filter[building_area]": "120",
    "filter[building_district]": "1",
    "filter[building_city]": "3",
    "filter[building_detail][0]": "9889",
    "filter[building_detail][1]": "29988",
    "filter[building_check_in]": "2022-02-21",
    "filter[building_check_out]": "2022-02-21",
    "filter[building_accommodation]": "4",
    "include[tags]": "enim",
    "include[notifications]": "quisquam",
    "include[contracts]": "aperiam",
    "include[buildings]": "voluptatem",
    "include[responsibles]": "ratione",
    "include[creator]": "ut",
    "include[customer]": "et",
    "include[proposals]": "eius",
    "include[activeProposals]": "dicta",
    "include[leads]": "cumque",
    "include[reason]": "id,notes",
    "include[step]": "id,description",
    "include[files]": "id,file_name",
    "include[origin]": "id,name",
    "include[lastHistory]": "id,created_at",
    "include[districts]": "id,name",
    "include[cities]": "id,name",
    "include[details]": "id",
    "include[buildingTypes]": "id,name",
    "include[buildingStages]": "id,name",
    "include[eventsNotConcludedNonRecurring]": "id,type,title",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/deals';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'sort' => 'id',
            'fields' => 'id,name,phone,email',
            'filter[title]' => 'Título do Negócio.',
            'filter[step_id]' => '1',
            'filter[step_date]' => '2022-08-31 00:00:00',
            'filter[status]' => 'won',
            'filter[status_date]' => '2022-12-06 10:17:16',
            'filter[type]' => 'sale',
            'filter[responsible][0]' => '123',
            'filter[responsible][1]' => '456',
            'filter[responsible][2]' => '789',
            'filter[customer_id]' => '1234',
            'filter[origin_id]' => '9',
            'filter[price]' => '1500.00',
            'filter[date]' => '2020-04-30',
            'filter[forecast]' => '2020-05-30',
            'filter[potential]' => 'hot',
            'filter[radar]' => '0',
            'filter[private]' => '0',
            'filter[position]' => '3',
            'filter[tag][0]' => '1326',
            'filter[tag][1]' => '1306',
            'filter[tag][2]' => '1305',
            'filter[building][0]' => '13914',
            'filter[building][1]' => '15155',
            'filter[building][2]' => '15467',
            'filter[extend]' => '2022-02-21',
            'filter[reason_id]' => '1',
            'filter[reason_notes]' => 'Cliente ganho',
            'filter[building_type][0]' => '5',
            'filter[building_type][1]' => '1',
            'filter[building_type][2]' => '3',
            'filter[building_stage][0]' => '3',
            'filter[building_furnishing]' => '',
            'filter[building_price_min]' => '1500.00',
            'filter[building_price_max]' => '2500.00',
            'filter[building_bedroom]' => '2',
            'filter[building_living_room]' => '1',
            'filter[building_parking]' => '1',
            'filter[building_bathroom]' => '3',
            'filter[building_area]' => '120',
            'filter[building_district]' => '1',
            'filter[building_city]' => '3',
            'filter[building_detail][0]' => '9889',
            'filter[building_detail][1]' => '29988',
            'filter[building_check_in]' => '2022-02-21',
            'filter[building_check_out]' => '2022-02-21',
            'filter[building_accommodation]' => '4',
            'include[tags]' => 'enim',
            'include[notifications]' => 'quisquam',
            'include[contracts]' => 'aperiam',
            'include[buildings]' => 'voluptatem',
            'include[responsibles]' => 'ratione',
            'include[creator]' => 'ut',
            'include[customer]' => 'et',
            'include[proposals]' => 'eius',
            'include[activeProposals]' => 'dicta',
            'include[leads]' => 'cumque',
            'include[reason]' => 'id,notes',
            'include[step]' => 'id,description',
            'include[files]' => 'id,file_name',
            'include[origin]' => 'id,name',
            'include[lastHistory]' => 'id,created_at',
            'include[districts]' => 'id,name',
            'include[cities]' => 'id,name',
            'include[details]' => 'id',
            'include[buildingTypes]' => 'id,name',
            'include[buildingStages]' => 'id,name',
            'include[eventsNotConcludedNonRecurring]' => 'id,type,title',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.apresenta.me/deals'
params = {
  'sort': 'id',
  'fields': 'id,name,phone,email',
  'filter[title]': 'Título do Negócio.',
  'filter[step_id]': '1',
  'filter[step_date]': '2022-08-31 00:00:00',
  'filter[status]': 'won',
  'filter[status_date]': '2022-12-06 10:17:16',
  'filter[type]': 'sale',
  'filter[responsible][0]': '123',
  'filter[responsible][1]': '456',
  'filter[responsible][2]': '789',
  'filter[customer_id]': '1234',
  'filter[origin_id]': '9',
  'filter[price]': '1500.00',
  'filter[date]': '2020-04-30',
  'filter[forecast]': '2020-05-30',
  'filter[potential]': 'hot',
  'filter[radar]': '0',
  'filter[private]': '0',
  'filter[position]': '3',
  'filter[tag][0]': '1326',
  'filter[tag][1]': '1306',
  'filter[tag][2]': '1305',
  'filter[building][0]': '13914',
  'filter[building][1]': '15155',
  'filter[building][2]': '15467',
  'filter[extend]': '2022-02-21',
  'filter[reason_id]': '1',
  'filter[reason_notes]': 'Cliente ganho',
  'filter[building_type][0]': '5',
  'filter[building_type][1]': '1',
  'filter[building_type][2]': '3',
  'filter[building_stage][0]': '3',
  'filter[building_furnishing]': '',
  'filter[building_price_min]': '1500.00',
  'filter[building_price_max]': '2500.00',
  'filter[building_bedroom]': '2',
  'filter[building_living_room]': '1',
  'filter[building_parking]': '1',
  'filter[building_bathroom]': '3',
  'filter[building_area]': '120',
  'filter[building_district]': '1',
  'filter[building_city]': '3',
  'filter[building_detail][0]': '9889',
  'filter[building_detail][1]': '29988',
  'filter[building_check_in]': '2022-02-21',
  'filter[building_check_out]': '2022-02-21',
  'filter[building_accommodation]': '4',
  'include[tags]': 'enim',
  'include[notifications]': 'quisquam',
  'include[contracts]': 'aperiam',
  'include[buildings]': 'voluptatem',
  'include[responsibles]': 'ratione',
  'include[creator]': 'ut',
  'include[customer]': 'et',
  'include[proposals]': 'eius',
  'include[activeProposals]': 'dicta',
  'include[leads]': 'cumque',
  'include[reason]': 'id,notes',
  'include[step]': 'id,description',
  'include[files]': 'id,file_name',
  'include[origin]': 'id,name',
  'include[lastHistory]': 'id,created_at',
  'include[districts]': 'id,name',
  'include[cities]': 'id,name',
  'include[details]': 'id',
  'include[buildingTypes]': 'id,name',
  'include[buildingStages]': 'id,name',
  'include[eventsNotConcludedNonRecurring]': 'id,type,title',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/deals

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

title

string

required

Título.

Example:

Título do Negócio.

step_id

integer

required

Etapa do Negócio.

Example:

step_date

date

Data da Etapa do Negócio.

Example:

2022-08-31 00:00:00

status

string

Status do Negócio.

Example:

won

status_date

date

Date do Status do Negócio.

Example:

2022-12-06 10:17:16

type

string

Tipo do Negócio (Radar).

Example:

sale

responsible

integer[]

required

Responsável(s) pelo Negócio.

Example:

[123,456,789]

customer_id

integer

required

Cliente do Negócio.

Example:

1234

origin_id

integer

Origem do Negócio.

Example:

created_by

integer

required

Criado por.

Example:

price

string

Valor do Negócio.

Example:

1500.00

date

Data do Negócio.

Example:

2020-04-30

forecast

date

Data da previsão de finalização do Negócio.

Example:

2020-05-30

potential

string

Potencial do Negócio. Options: cold, hot, scalding, warm.

Example:

hot

radar

boolean

Radar Ativo para o Negócio.

Example:

private

boolean

Visibilidade do Negócio.

Example:

position

integer

Posição do negócio (Kanban).

Example:

tag

integer[]

Tags para o Negócio.

Example:

[1326,1306,1305]

building

integer[]

Imóveis para o Negócio.

Example:

[13914,15155,15467]

extend

date

Prorrogação do Negócio.

Example:

2022-02-21

reason_id

integer

Motivo do Negócio quando o status é alterado.

Example:

reason_notes

string

Observações do motivo quando o status do Negócio é alterado.

Example:

Cliente ganho

building_type

integer[]

Tipos de Imóveis para o Radar de Negócio.

Example:

[5,1,3]

building_stage

integer[]

Estágio dos Imóveis para o Radar de Negócio.

Example:

[3]

building_furnishing

string[]

Mobília dos Imóveis para o Radar de Negócio.

building_price_min

string

Valor mínimo dos Imóveis do Negócio (Radar).

Example:

1500.00

building_price_max

string

Valor máximo dos Imóveis do Negócio (Radar).

Example:

2500.00

building_bedroom

integer

Quantidade de quartos para o Radar de Negócio.

Example:

building_living_room

integer

Quantidade de salas para o Radar de Negócio.

Example:

building_parking

integer

Quantidade de vagas de estacionamento para o Radar de Negócio.

Example:

building_bathroom

integer

Quantidade de banheiros para o Radar de Negócio.

Example:

building_area

integer

Área em metros quadrados para o Radar de Negócio.

Example:

120

building_district

string

Bairro para o Radar de Negócio.

Example:

building_city

string

Cidade para o Radar de Negócio.

Example:

building_detail

integer[]

Detalhes do Imóvel para o Radar de Negócio.

Example:

[9889,29988]

building_check_in

date

Check-in do Imóvel para o Radar de Negócio.

Example:

2022-02-21

building_check_out

date

Check-out do Imóvel para o Radar de Negócio.

Example:

2022-02-21

building_accommodation

integer

Quantidade de acomodações do Imóvel para o Radar de Negócio.

Example:

Auth

Bearer

Headers

Body

{ "title": "T\u00edtulo do Neg\u00f3cio.", "step_id": 1, "step_date": "2022-08-31 00:00:00", "status": "won", "status_date": "2022-12-06 10:17:16", "type": "sale", "responsible": [ 123, 456, 789 ], "customer_id": 1234, "origin_id": 9, "created_by": 12, "price": "1500.00", "date": "2020-04-30", "forecast": "2020-05-30", "potential": "hot", "radar": true, "private": true, "position": 3, "tag": [ 1326, 1306, 1305 ], "building": [ 13914, 15155, 15467 ], "extend": "2022-02-21", "reason_id": 1, "reason_notes": "Cliente ganho", "building_type": [ 5, 1, 3 ], "building_stage": [ 3 ], "building_furnishing": null, "building_price_min": "1500.00", "building_price_max": "2500.00", "building_bedroom": 2, "building_living_room": 1, "building_parking": 1, "building_bathroom": 3, "building_area": 120, "building_district": "1", "building_city": "3", "building_detail": [ 9889, 29988 ], "building_check_in": "2022-02-21", "building_check_out": "2022-02-21", "building_accommodation": 4 }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/deals" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Título do Negócio.\",
    \"step_id\": 1,
    \"step_date\": \"2022-08-31 00:00:00\",
    \"status\": \"won\",
    \"status_date\": \"2022-12-06 10:17:16\",
    \"type\": \"sale\",
    \"responsible\": [
        123,
        456,
        789
    ],
    \"customer_id\": 1234,
    \"origin_id\": 9,
    \"created_by\": 12,
    \"price\": \"1500.00\",
    \"date\": \"2020-04-30\",
    \"forecast\": \"2020-05-30\",
    \"potential\": \"hot\",
    \"radar\": true,
    \"private\": true,
    \"position\": 3,
    \"tag\": [
        1326,
        1306,
        1305
    ],
    \"building\": [
        13914,
        15155,
        15467
    ],
    \"extend\": \"2022-02-21\",
    \"reason_id\": 1,
    \"reason_notes\": \"Cliente ganho\",
    \"building_type\": [
        5,
        1,
        3
    ],
    \"building_stage\": [
        3
    ],
    \"building_furnishing\": null,
    \"building_price_min\": \"1500.00\",
    \"building_price_max\": \"2500.00\",
    \"building_bedroom\": 2,
    \"building_living_room\": 1,
    \"building_parking\": 1,
    \"building_bathroom\": 3,
    \"building_area\": 120,
    \"building_district\": \"1\",
    \"building_city\": \"3\",
    \"building_detail\": [
        9889,
        29988
    ],
    \"building_check_in\": \"2022-02-21\",
    \"building_check_out\": \"2022-02-21\",
    \"building_accommodation\": 4
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/deals';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'Título do Negócio.',
            'step_id' => 1,
            'step_date' => '2022-08-31 00:00:00',
            'status' => 'won',
            'status_date' => '2022-12-06 10:17:16',
            'type' => 'sale',
            'responsible' => [
                123,
                456,
                789,
            ],
            'customer_id' => 1234,
            'origin_id' => 9,
            'created_by' => 12,
            'price' => '1500.00',
            'date' => '2020-04-30',
            'forecast' => '2020-05-30',
            'potential' => 'hot',
            'radar' => true,
            'private' => true,
            'position' => 3,
            'tag' => [
                1326,
                1306,
                1305,
            ],
            'building' => [
                13914,
                15155,
                15467,
            ],
            'extend' => '2022-02-21',
            'reason_id' => 1,
            'reason_notes' => 'Cliente ganho',
            'building_type' => [
                5,
                1,
                3,
            ],
            'building_stage' => [
                3,
            ],
            'building_furnishing' => null,
            'building_price_min' => '1500.00',
            'building_price_max' => '2500.00',
            'building_bedroom' => 2,
            'building_living_room' => 1,
            'building_parking' => 1,
            'building_bathroom' => 3,
            'building_area' => 120,
            'building_district' => '1',
            'building_city' => '3',
            'building_detail' => [
                9889,
                29988,
            ],
            'building_check_in' => '2022-02-21',
            'building_check_out' => '2022-02-21',
            'building_accommodation' => 4,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Obter

GET

https://api.apresenta.me/deals/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Negócio

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,phone,email

include[tags]

string

Retorna as tags do negócio

Example:

earum

include[notifications]

string

Retorna as notificações do negócio

Example:

veritatis

include[contracts]

string

Retorna os contratos vinculados ao negócio

Example:

molestiae

include[buildings]

string

Retorna os imóveis vinculados ao negócio

Example:

nulla

include[responsibles]

string

Retorna os responsáveis do negócio

Example:

qui

include[creator]

string

Retorna o criador do negócio

Example:

sequi

include[customer]

string

Retorna o cliente do negócio

Example:

inventore

include[proposals]

string

Retorna as propostas do negócio

Example:

sed

include[activeProposals]

string

Retorna as propostas (pendentes ou aceitas) do negócio.

Example:

quo

include[leads]

string

Retorna os leads do negócio

Example:

omnis

include[reason]

string

Retorna o motivo do status do negócio.

Example:

id,notes

include[step]

string

Retorna a etapa do negócio.

Example:

id,description

include[files]

string

Retorna os arquivos do negócio.

Example:

id,file_name

include[origin]

string

Retorna a origem do negócio.

Example:

id,name

include[lastHistory]

string

Retorna o último histórico da negociação.

Example:

id,created_at

include[districts]

string

Retorna os bairros dos imóveis (Radar).

Example:

id,name

include[cities]

string

Retorna as cidades dos imóveis (Radar).

Example:

id,name

include[details]

string

Retorna os detalhes dos imóveis (Radar).

Example:

include[buildingTypes]

string

Retorna os tipos dos imóveis (Radar).

Example:

id,name

include[buildingStages]

string

Retorna os estágios dos imóveis (Radar).

Example:

id,name

include[eventsNotConcludedNonRecurring]

string

Retorna eventos não recorrentes que não estão concluídos.

Example:

id,type,title

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/deals/5?sort=id&fields=id%2Cname%2Cphone%2Cemail&include%5Btags%5D=earum&include%5Bnotifications%5D=veritatis&include%5Bcontracts%5D=molestiae&include%5Bbuildings%5D=nulla&include%5Bresponsibles%5D=qui&include%5Bcreator%5D=sequi&include%5Bcustomer%5D=inventore&include%5Bproposals%5D=sed&include%5BactiveProposals%5D=quo&include%5Bleads%5D=omnis&include%5Breason%5D=id%2Cnotes&include%5Bstep%5D=id%2Cdescription&include%5Bfiles%5D=id%2Cfile_name&include%5Borigin%5D=id%2Cname&include%5BlastHistory%5D=id%2Ccreated_at&include%5Bdistricts%5D=id%2Cname&include%5Bcities%5D=id%2Cname&include%5Bdetails%5D=id&include%5BbuildingTypes%5D=id%2Cname&include%5BbuildingStages%5D=id%2Cname&include%5BeventsNotConcludedNonRecurring%5D=id%2Ctype%2Ctitle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/deals/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Negócio

Example:

Body Parameters

title

string

Título.

Example:

Título do Negócio.

step_id

integer

Etapa do Negócio.

Example:

step_date

date

Data da Etapa do Negócio.

Example:

2022-08-31 00:00:00

status

string

Status do Negócio.

Example:

won

status_date

date

Date do Status do Negócio.

Example:

2022-12-06 10:17:16

type

string

Tipo do Negócio (Radar).

Example:

sale

responsible

integer[]

Responsável(s) pelo Negócio.

Example:

[123,456,789]

customer_id

integer

Cliente do Negócio.

Example:

1234

origin_id

integer

Origem do Negócio.

Example:

created_by

integer

Criado por.

Example:

price

string

Valor do Negócio.

Example:

1500.00

date

Data do Negócio.

Example:

2020-04-30

forecast

date

Data da previsão de finalização do Negócio.

Example:

2020-05-30

potential

string

Potencial do Negócio. Options: cold, hot, scalding, warm.

Example:

hot

radar

boolean

Radar Ativo para o Negócio.

private

boolean

Visibilidade do Negócio.

position

integer

Posição do negócio (Kanban).

Example:

tag

integer[]

Tags para o Negócio.

Example:

[1326,1306,1305]

building

integer[]

Imóveis para o Negócio.

Example:

[13914,15155,15467]

extend

date

Prorrogação do Negócio.

Example:

2022-02-21

reason_id

integer

Motivo do Negócio quando o status é alterado.

Example:

reason_notes

string

Observações do motivo quando o status do Negócio é alterado.

Example:

Cliente ganho

building_type

integer[]

Tipos de Imóveis para o Radar de Negócio.

Example:

[5,1,3]

building_stage

integer[]

Estágio dos Imóveis para o Radar de Negócio.

Example:

[3]

building_furnishing

string[]

Mobília dos Imóveis para o Radar de Negócio.

building_price_min

string

Valor mínimo dos Imóveis do Negócio (Radar).

Example:

1500.00

building_price_max

string

Valor máximo dos Imóveis do Negócio (Radar).

Example:

2500.00

building_bedroom

integer

Quantidade de quartos para o Radar de Negócio.

Example:

building_living_room

integer

Quantidade de salas para o Radar de Negócio.

Example:

building_parking

integer

Quantidade de vagas de estacionamento para o Radar de Negócio.

Example:

building_bathroom

integer

Quantidade de banheiros para o Radar de Negócio.

Example:

building_area

integer

Área em metros quadrados para o Radar de Negócio.

Example:

120

building_district

string

Bairro para o Radar de Negócio.

Example:

building_city

string

Cidade para o Radar de Negócio.

Example:

building_detail

integer[]

Detalhes do Imóvel para o Radar de Negócio.

Example:

[9889,29988]

building_check_in

date

Check-in do Imóvel para o Radar de Negócio.

Example:

2022-02-21

building_check_out

date

Check-out do Imóvel para o Radar de Negócio.

Example:

2022-02-21

building_accommodation

integer

Quantidade de acomodações do Imóvel para o Radar de Negócio.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "title": "T\u00edtulo do Neg\u00f3cio.", "step_id": 1, "step_date": "2022-08-31 00:00:00", "status": "won", "status_date": "2022-12-06 10:17:16", "type": "sale", "responsible": [ 123, 456, 789 ], "customer_id": 1234, "origin_id": 9, "created_by": 19, "price": "1500.00", "date": "2020-04-30", "forecast": "2020-05-30", "potential": "hot", "radar": false, "private": false, "position": 3, "tag": [ 1326, 1306, 1305 ], "building": [ 13914, 15155, 15467 ], "extend": "2022-02-21", "reason_id": 1, "reason_notes": "Cliente ganho", "building_type": [ 5, 1, 3 ], "building_stage": [ 3 ], "building_furnishing": null, "building_price_min": "1500.00", "building_price_max": "2500.00", "building_bedroom": 2, "building_living_room": 1, "building_parking": 1, "building_bathroom": 3, "building_area": 120, "building_district": "1", "building_city": "3", "building_detail": [ 9889, 29988 ], "building_check_in": "2022-02-21", "building_check_out": "2022-02-21", "building_accommodation": 4 }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/deals/13" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Título do Negócio.\",
    \"step_id\": 1,
    \"step_date\": \"2022-08-31 00:00:00\",
    \"status\": \"won\",
    \"status_date\": \"2022-12-06 10:17:16\",
    \"type\": \"sale\",
    \"responsible\": [
        123,
        456,
        789
    ],
    \"customer_id\": 1234,
    \"origin_id\": 9,
    \"created_by\": 19,
    \"price\": \"1500.00\",
    \"date\": \"2020-04-30\",
    \"forecast\": \"2020-05-30\",
    \"potential\": \"hot\",
    \"radar\": false,
    \"private\": false,
    \"position\": 3,
    \"tag\": [
        1326,
        1306,
        1305
    ],
    \"building\": [
        13914,
        15155,
        15467
    ],
    \"extend\": \"2022-02-21\",
    \"reason_id\": 1,
    \"reason_notes\": \"Cliente ganho\",
    \"building_type\": [
        5,
        1,
        3
    ],
    \"building_stage\": [
        3
    ],
    \"building_furnishing\": null,
    \"building_price_min\": \"1500.00\",
    \"building_price_max\": \"2500.00\",
    \"building_bedroom\": 2,
    \"building_living_room\": 1,
    \"building_parking\": 1,
    \"building_bathroom\": 3,
    \"building_area\": 120,
    \"building_district\": \"1\",
    \"building_city\": \"3\",
    \"building_detail\": [
        9889,
        29988
    ],
    \"building_check_in\": \"2022-02-21\",
    \"building_check_out\": \"2022-02-21\",
    \"building_accommodation\": 4
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/deals/13';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'Título do Negócio.',
            'step_id' => 1,
            'step_date' => '2022-08-31 00:00:00',
            'status' => 'won',
            'status_date' => '2022-12-06 10:17:16',
            'type' => 'sale',
            'responsible' => [
                123,
                456,
                789,
            ],
            'customer_id' => 1234,
            'origin_id' => 9,
            'created_by' => 19,
            'price' => '1500.00',
            'date' => '2020-04-30',
            'forecast' => '2020-05-30',
            'potential' => 'hot',
            'radar' => false,
            'private' => false,
            'position' => 3,
            'tag' => [
                1326,
                1306,
                1305,
            ],
            'building' => [
                13914,
                15155,
                15467,
            ],
            'extend' => '2022-02-21',
            'reason_id' => 1,
            'reason_notes' => 'Cliente ganho',
            'building_type' => [
                5,
                1,
                3,
            ],
            'building_stage' => [
                3,
            ],
            'building_furnishing' => null,
            'building_price_min' => '1500.00',
            'building_price_max' => '2500.00',
            'building_bedroom' => 2,
            'building_living_room' => 1,
            'building_parking' => 1,
            'building_bathroom' => 3,
            'building_area' => 120,
            'building_district' => '1',
            'building_city' => '3',
            'building_detail' => [
                9889,
                29988,
            ],
            'building_check_in' => '2022-02-21',
            'building_check_out' => '2022-02-21',
            'building_accommodation' => 4,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Excluir

DELETE

https://api.apresenta.me/deals/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Negócio

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/deals/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Duplicar

PUT

https://api.apresenta.me/deals/{deal_id}/duplicate

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

deal_id

integer

required

ID do Negócio

Example:

Body Parameters

medias

boolean

Define se duplica os imóveis vinculados ao Negócio

season_packs

boolean

Define se duplica os documentos do Negócio

Auth

Bearer

Headers

URL Parameters

Body

{ "medias": false, "season_packs": false }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/deals/10/duplicate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"medias\": false,
    \"season_packs\": false
}"

Pessoas

Aprovar

PUT

https://api.apresenta.me/persons/approve/{person_id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

person_id

integer

required

ID da pessoa

Example:

Body Parameters

check

boolean

Aprovar cadastro da pessoa.

Example:

merge

boolean

Indica se deve unificar os dados da pessoa.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "check": true, "merge": true }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/persons/approve/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"check\": true,
    \"merge\": true
}"

Pesquisar

GET

https://api.apresenta.me/persons

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,tax_id

filter[id]

integer

ID da pessoa.

Example:

filter[id2]

integer

ID por empresa da pessoa.

Example:

filter[name]

string

Nome da pessoa.

Example:

carlos%

filter[responsible]

string

Filtra por usuários responsáveis.

Example:

3,5

filter[type]

string

Vínculo com a imobiliária.

Example:

owner

filter[access]

string

Tipo de acesso à pessoa.

Example:

all

filter[active]

boolean

Pessoas ativas.

Example:

filter[origin_id]

integer

ID de origem.

Example:

filter[reference]

string

Referência.

Example:

R55

filter[gender]

string

Sexo.

Example:

filter[approved]

boolean

Pessoas aprovadas.

Example:

filter[juridical]

string

Tipo de pessoa (física, jurídica).

Example:

filter[tax_id]

string

CPF/CNPJ.

Example:

57157949008

filter[tag]

integer

Tags.

Example:

1182

filter[rg]

string

RG.

Example:

45.461.713-6

filter[rg_emmiter]

string

Emissor do RG.

Example:

ssp

filter[rg_dispatcher]

string

Data de Emissão do RG.

Example:

2011-09-08

filter[cnh]

string

N° da CNH.

Example:

43375783744

filter[nationality]

string

Nacionalidade.

Example:

Brasileira

filter[naturality]

string

Naturalidade.

Example:

Rio do Sul

filter[birthplace]

string

Local de nascimento.

Example:

Rio do Sul

filter[birth_date]

string

Data de nascimento.

Example:

2011-09-08

filter[marital]

string

Estado civil.

Example:

married

filter[spouse_id]

integer

ID do cônjuge.

Example:

filter[legal_representative_id]

integer

ID do Representante legal.

Example:

filter[contacted_at]

string

Data de contato.

Example:

2021-03-22 11:31:00

filter[last_contact_at]

string

Última data de contato via Lead.

Example:

2021-03-22 11:31:00

filter[father_name]

string

Nome do pai.

Example:

Rogério

filter[mother_name]

string

Nome da mãe.

Example:

Maria

filter[occupation_id]

integer

ID da profissão.

Example:

filter[occupation]

string

Descrição da profissão.

Example:

Corretor imobiliário

filter[employment_link]

string

Vínculo empregatício.

Example:

EMP

filter[employment_business]

string

Nome da empresa de trabalho.

Example:

Apresenta.me

filter[employment_time]

integer

Tempo de empresa.

Example:

filter[employment_phone]

string

Telefone da empresa.

Example:

+55 47 98420-8674

filter[employment_address]

string

Endereço da empresa.

Example:

Rua José Debieux

filter[income]

string

Renda.

Example:

1500.00

filter[income_other]

string

Outras rendas.

Example:

600.00

filter[notes]

string

Observações

Example:

Entrou em contato pelo Facebook

filter[company_name]

string

Razão social.

Example:

Empresa Exemplo

filter[state_inscription_type]

string

Indicador IE.

Example:

immune

filter[state_inscription]

string

Inscrição estadual (IE).

Example:

361944136227

filter[municipal_inscription]

string

Inscrição municipal (IM).

Example:

361944136227

filter[login_date]

string

Último login.

Example:

2021-03-17 15:50:22

filter[login_active]

boolean

Example:

filter[login]

string

Example:

carlos_oliveira

filter[financial_alert]

boolean

Alerta financeiro habilitado.

Example:

filter[create_building_alert]

boolean

Alerta cadastro de imóveis habilitado.

Example:

include[contacts]

string

Retorna os contatos da pessoa.

Example:

phone,email

include[contact]

string

Retorna o contato principal da pessoa.

Example:

phone,email

include[spouse]

string

Retorna os dados do cônjuge.

Example:

id,name

include[bankAccounts]

string

Retorna as contas da pessoa.

Example:

id,description

include[bankAccount]

string

Retorna a conta principal ativa.

Example:

id,description

include[occupation]

string

Retorna a profissão da pessoa.

Example:

id,name

include[buildings]

string

Retorna os dados dos negócios em que a pessoa é cliente.

Example:

id,title

include[contractTenant]

string

Retorna os contratos em que a pessoa é inquilina.

Example:

id,building_id,type

include[contractTenantRent]

string

Retorna os contratos em que a pessoa é inquilina de aluguel.

Example:

id,building_id

include[contractOwner]

string

Retorna os contratos em que a pessoa é proprietária.

Example:

id,building_id

include[tickets]

string

Retorna os tickets da pessoa.

Example:

id,title

include[deals]

string

Retorna os dados dos negócios em que a pessoa é cliente.

Example:

id,title

include[origin]

string

Retorna os dados da origem da pessoa

Example:

qui

include[tags]

string

Retorna as Tags da pessoa

Example:

eaque

include[responsibles]

string

Retorna as pessoas que esta pessoa é responsável.

Example:

id,name

include[responsibleGroups]

string

Retorna os grupos de usuário.

Example:

id,name

include[legalRepresentative]

string

Retorna o Representante legal.

Example:

id,name

include[image]

string

Retorna as imagens.

Example:

id,file_name

include[files]

string

Retorna os arquivos.

Example:

id,file_name

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/persons?sort=id&fields=id%2Cname%2Ctax_id&filter%5Bid%5D=2&filter%5Bid2%5D=2&filter%5Bname%5D=carlos%25&filter%5Bresponsible%5D=3%2C5&filter%5Btype%5D=owner&filter%5Baccess%5D=all&filter%5Bactive%5D=1&filter%5Borigin_id%5D=29&filter%5Breference%5D=R55&filter%5Bgender%5D=M&filter%5Bapproved%5D=1&filter%5Bjuridical%5D=F&filter%5Btax_id%5D=57157949008&filter%5Btag%5D=1182&filter%5Brg%5D=45.461.713-6&filter%5Brg_emmiter%5D=ssp&filter%5Brg_dispatcher%5D=2011-09-08&filter%5Bcnh%5D=43375783744&filter%5Bnationality%5D=Brasileira&filter%5Bnaturality%5D=Rio+do+Sul&filter%5Bbirthplace%5D=Rio+do+Sul&filter%5Bbirth_date%5D=2011-09-08&filter%5Bmarital%5D=married&filter%5Bspouse_id%5D=5&filter%5Blegal_representative_id%5D=80&filter%5Bcontacted_at%5D=2021-03-22+11%3A31%3A00&filter%5Blast_contact_at%5D=2021-03-22+11%3A31%3A00&filter%5Bfather_name%5D=Rog%C3%A9rio&filter%5Bmother_name%5D=Maria&filter%5Boccupation_id%5D=10&filter%5Boccupation%5D=Corretor+imobili%C3%A1rio&filter%5Bemployment_link%5D=EMP&filter%5Bemployment_business%5D=Apresenta.me&filter%5Bemployment_time%5D=6&filter%5Bemployment_phone%5D=%2B55+47+98420-8674&filter%5Bemployment_address%5D=Rua+Jos%C3%A9+Debieux&filter%5Bincome%5D=1500.00&filter%5Bincome_other%5D=600.00&filter%5Bnotes%5D=Entrou+em+contato+pelo+Facebook&filter%5Bcompany_name%5D=Empresa+Exemplo&filter%5Bstate_inscription_type%5D=immune&filter%5Bstate_inscription%5D=361944136227&filter%5Bmunicipal_inscription%5D=361944136227&filter%5Blogin_date%5D=2021-03-17+15%3A50%3A22&filter%5Blogin_active%5D=1&filter%5Blogin%5D=carlos_oliveira&filter%5Bfinancial_alert%5D=1&filter%5Bcreate_building_alert%5D=1&include%5Bcontacts%5D=phone%2Cemail&include%5Bcontact%5D=phone%2Cemail&include%5Bspouse%5D=id%2Cname&include%5BbankAccounts%5D=id%2Cdescription&include%5BbankAccount%5D=id%2Cdescription&include%5Boccupation%5D=id%2Cname&include%5Bbuildings%5D=id%2Ctitle&include%5BcontractTenant%5D=id%2Cbuilding_id%2Ctype&include%5BcontractTenantRent%5D=id%2Cbuilding_id&include%5BcontractOwner%5D=id%2Cbuilding_id&include%5Btickets%5D=id%2Ctitle&include%5Bdeals%5D=id%2Ctitle&include%5Borigin%5D=qui&include%5Btags%5D=eaque&include%5Bresponsibles%5D=id%2Cname&include%5BresponsibleGroups%5D=id%2Cname&include%5BlegalRepresentative%5D=id%2Cname&include%5Bimage%5D=id%2Cfile_name&include%5Bfiles%5D=id%2Cfile_name" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.apresenta.me/persons"
);

const params = {
    "sort": "id",
    "fields": "id,name,tax_id",
    "filter[id]": "2",
    "filter[id2]": "2",
    "filter[name]": "carlos%",
    "filter[responsible]": "3,5",
    "filter[type]": "owner",
    "filter[access]": "all",
    "filter[active]": "1",
    "filter[origin_id]": "29",
    "filter[reference]": "R55",
    "filter[gender]": "M",
    "filter[approved]": "1",
    "filter[juridical]": "F",
    "filter[tax_id]": "57157949008",
    "filter[tag]": "1182",
    "filter[rg]": "45.461.713-6",
    "filter[rg_emmiter]": "ssp",
    "filter[rg_dispatcher]": "2011-09-08",
    "filter[cnh]": "43375783744",
    "filter[nationality]": "Brasileira",
    "filter[naturality]": "Rio do Sul",
    "filter[birthplace]": "Rio do Sul",
    "filter[birth_date]": "2011-09-08",
    "filter[marital]": "married",
    "filter[spouse_id]": "5",
    "filter[legal_representative_id]": "80",
    "filter[contacted_at]": "2021-03-22 11:31:00",
    "filter[last_contact_at]": "2021-03-22 11:31:00",
    "filter[father_name]": "Rogério",
    "filter[mother_name]": "Maria",
    "filter[occupation_id]": "10",
    "filter[occupation]": "Corretor imobiliário",
    "filter[employment_link]": "EMP",
    "filter[employment_business]": "Apresenta.me",
    "filter[employment_time]": "6",
    "filter[employment_phone]": "+55 47 98420-8674",
    "filter[employment_address]": "Rua José Debieux",
    "filter[income]": "1500.00",
    "filter[income_other]": "600.00",
    "filter[notes]": "Entrou em contato pelo Facebook",
    "filter[company_name]": "Empresa Exemplo",
    "filter[state_inscription_type]": "immune",
    "filter[state_inscription]": "361944136227",
    "filter[municipal_inscription]": "361944136227",
    "filter[login_date]": "2021-03-17 15:50:22",
    "filter[login_active]": "1",
    "filter[login]": "carlos_oliveira",
    "filter[financial_alert]": "1",
    "filter[create_building_alert]": "1",
    "include[contacts]": "phone,email",
    "include[contact]": "phone,email",
    "include[spouse]": "id,name",
    "include[bankAccounts]": "id,description",
    "include[bankAccount]": "id,description",
    "include[occupation]": "id,name",
    "include[buildings]": "id,title",
    "include[contractTenant]": "id,building_id,type",
    "include[contractTenantRent]": "id,building_id",
    "include[contractOwner]": "id,building_id",
    "include[tickets]": "id,title",
    "include[deals]": "id,title",
    "include[origin]": "qui",
    "include[tags]": "eaque",
    "include[responsibles]": "id,name",
    "include[responsibleGroups]": "id,name",
    "include[legalRepresentative]": "id,name",
    "include[image]": "id,file_name",
    "include[files]": "id,file_name",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/persons';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'sort' => 'id',
            'fields' => 'id,name,tax_id',
            'filter[id]' => '2',
            'filter[id2]' => '2',
            'filter[name]' => 'carlos%',
            'filter[responsible]' => '3,5',
            'filter[type]' => 'owner',
            'filter[access]' => 'all',
            'filter[active]' => '1',
            'filter[origin_id]' => '29',
            'filter[reference]' => 'R55',
            'filter[gender]' => 'M',
            'filter[approved]' => '1',
            'filter[juridical]' => 'F',
            'filter[tax_id]' => '57157949008',
            'filter[tag]' => '1182',
            'filter[rg]' => '45.461.713-6',
            'filter[rg_emmiter]' => 'ssp',
            'filter[rg_dispatcher]' => '2011-09-08',
            'filter[cnh]' => '43375783744',
            'filter[nationality]' => 'Brasileira',
            'filter[naturality]' => 'Rio do Sul',
            'filter[birthplace]' => 'Rio do Sul',
            'filter[birth_date]' => '2011-09-08',
            'filter[marital]' => 'married',
            'filter[spouse_id]' => '5',
            'filter[legal_representative_id]' => '80',
            'filter[contacted_at]' => '2021-03-22 11:31:00',
            'filter[last_contact_at]' => '2021-03-22 11:31:00',
            'filter[father_name]' => 'Rogério',
            'filter[mother_name]' => 'Maria',
            'filter[occupation_id]' => '10',
            'filter[occupation]' => 'Corretor imobiliário',
            'filter[employment_link]' => 'EMP',
            'filter[employment_business]' => 'Apresenta.me',
            'filter[employment_time]' => '6',
            'filter[employment_phone]' => '+55 47 98420-8674',
            'filter[employment_address]' => 'Rua José Debieux',
            'filter[income]' => '1500.00',
            'filter[income_other]' => '600.00',
            'filter[notes]' => 'Entrou em contato pelo Facebook',
            'filter[company_name]' => 'Empresa Exemplo',
            'filter[state_inscription_type]' => 'immune',
            'filter[state_inscription]' => '361944136227',
            'filter[municipal_inscription]' => '361944136227',
            'filter[login_date]' => '2021-03-17 15:50:22',
            'filter[login_active]' => '1',
            'filter[login]' => 'carlos_oliveira',
            'filter[financial_alert]' => '1',
            'filter[create_building_alert]' => '1',
            'include[contacts]' => 'phone,email',
            'include[contact]' => 'phone,email',
            'include[spouse]' => 'id,name',
            'include[bankAccounts]' => 'id,description',
            'include[bankAccount]' => 'id,description',
            'include[occupation]' => 'id,name',
            'include[buildings]' => 'id,title',
            'include[contractTenant]' => 'id,building_id,type',
            'include[contractTenantRent]' => 'id,building_id',
            'include[contractOwner]' => 'id,building_id',
            'include[tickets]' => 'id,title',
            'include[deals]' => 'id,title',
            'include[origin]' => 'qui',
            'include[tags]' => 'eaque',
            'include[responsibles]' => 'id,name',
            'include[responsibleGroups]' => 'id,name',
            'include[legalRepresentative]' => 'id,name',
            'include[image]' => 'id,file_name',
            'include[files]' => 'id,file_name',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.apresenta.me/persons'
params = {
  'sort': 'id',
  'fields': 'id,name,tax_id',
  'filter[id]': '2',
  'filter[id2]': '2',
  'filter[name]': 'carlos%',
  'filter[responsible]': '3,5',
  'filter[type]': 'owner',
  'filter[access]': 'all',
  'filter[active]': '1',
  'filter[origin_id]': '29',
  'filter[reference]': 'R55',
  'filter[gender]': 'M',
  'filter[approved]': '1',
  'filter[juridical]': 'F',
  'filter[tax_id]': '57157949008',
  'filter[tag]': '1182',
  'filter[rg]': '45.461.713-6',
  'filter[rg_emmiter]': 'ssp',
  'filter[rg_dispatcher]': '2011-09-08',
  'filter[cnh]': '43375783744',
  'filter[nationality]': 'Brasileira',
  'filter[naturality]': 'Rio do Sul',
  'filter[birthplace]': 'Rio do Sul',
  'filter[birth_date]': '2011-09-08',
  'filter[marital]': 'married',
  'filter[spouse_id]': '5',
  'filter[legal_representative_id]': '80',
  'filter[contacted_at]': '2021-03-22 11:31:00',
  'filter[last_contact_at]': '2021-03-22 11:31:00',
  'filter[father_name]': 'Rogério',
  'filter[mother_name]': 'Maria',
  'filter[occupation_id]': '10',
  'filter[occupation]': 'Corretor imobiliário',
  'filter[employment_link]': 'EMP',
  'filter[employment_business]': 'Apresenta.me',
  'filter[employment_time]': '6',
  'filter[employment_phone]': '+55 47 98420-8674',
  'filter[employment_address]': 'Rua José Debieux',
  'filter[income]': '1500.00',
  'filter[income_other]': '600.00',
  'filter[notes]': 'Entrou em contato pelo Facebook',
  'filter[company_name]': 'Empresa Exemplo',
  'filter[state_inscription_type]': 'immune',
  'filter[state_inscription]': '361944136227',
  'filter[municipal_inscription]': '361944136227',
  'filter[login_date]': '2021-03-17 15:50:22',
  'filter[login_active]': '1',
  'filter[login]': 'carlos_oliveira',
  'filter[financial_alert]': '1',
  'filter[create_building_alert]': '1',
  'include[contacts]': 'phone,email',
  'include[contact]': 'phone,email',
  'include[spouse]': 'id,name',
  'include[bankAccounts]': 'id,description',
  'include[bankAccount]': 'id,description',
  'include[occupation]': 'id,name',
  'include[buildings]': 'id,title',
  'include[contractTenant]': 'id,building_id,type',
  'include[contractTenantRent]': 'id,building_id',
  'include[contractOwner]': 'id,building_id',
  'include[tickets]': 'id,title',
  'include[deals]': 'id,title',
  'include[origin]': 'qui',
  'include[tags]': 'eaque',
  'include[responsibles]': 'id,name',
  'include[responsibleGroups]': 'id,name',
  'include[legalRepresentative]': 'id,name',
  'include[image]': 'id,file_name',
  'include[files]': 'id,file_name',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/persons

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Nome da pessoa.

Example:

Carlos Ciclano

responsible

string[]

Usuários responsáveis.

Example:

[3,5]

type

string[]

Vínculo com a imobiliária.

access

string

Tipo de acesso à pessoa.

Example:

all

active

boolean

Status.

Example:

origin_id

integer

ID da origem.

Example:

origin

string

Origem da pessoa, caso não saiba o ID.

Example:

Facebook ADS

reference

string

Referência.

Example:

R55

gender

string

Gênero.

Example:

approved

boolean

Aprovada.

Example:

juridical

string

Tipo de cadastro de pessoa (física, jurídica).

Example:

tax_id

integer

CPF/CNPJ.

Example:

57157949008

tag

string[]

Tags.

Example:

[1182]

string

RG.

Example:

45.461.713-6

rg_emmiter

string

Emissor do RG.

Example:

ssp

rg_dispatcher

date

Data de emissão do RG

Example:

2011-09-08

cnh

integer

CNH.

Example:

43375783744

nationality

string

Nacionalidade.

Example:

Brasileira

naturality

string

Naturalidade.

Example:

Riosulense

birthplace

string

Local de nascimento.

Example:

Riosulense

birth_date

date

Data de nascimento.

Example:

2011-09-08

marital

string

Estado civil.

Example:

married

spouse_id

integer

ID do Cônjuge.

Example:

legal_representative_id

integer

Representante legal.

Example:

contacted_at

date

Data de contato.

Example:

2021-03-22 11:31:00

last_contact_at

date

Data do último contato.

Example:

2021-03-22 11:31:00

father_name

string

Nome do pai.

Example:

Rogério

mother_name

string

Nome da mãe.

Example:

Maria

occupation_id

integer

ID de profissão .

Example:

occupation

string

Profissão.

Example:

Corretor imobiliário

employment_link

string

Vínculo empregatício.

Example:

EMP

employment_business

string

Nome da empresa de trabalho.

Example:

Apresenta.me

employment_time

integer

Tempo de empresa.

Example:

employment_phone

string

Telefone da empresa.

Example:

+55 47 98420-8674

employment_address

string

Endereço da empresa.

Example:

Rua José Debieux

income

numeric

Renda.

Example:

1500.00

income_other

Outras

rendas.

Example:

600.00

notes

string

Observações.

Example:

Entrou em contato pelo Facebook

company_name

string

Razão social.

Example:

Apresenta.me

state_inscription_type

string

Indicador IE.

Example:

immune

state_inscription

integer

Inscrição estadual (IE).

Example:

361944136227

municipal_inscription

integer

Inscrição Municipal (IM).

Example:

361944136227

login_date

date

Data do último login.

Example:

2021-03-17 15:50:22

login_active

boolean

Example:

string

Example:

carlos_oliveira

password

string

Senha.

Example:

senha@senha3412

financial_alert

boolean

Alerta financeiro habilitado.

Example:

create_building_alert

boolean

Alerta cadastro de imóvel habilitado.

Example:

Auth

Bearer

Headers

Body

{ "name": "Carlos Ciclano", "responsible": [ 3, 5 ], "type": null, "access": "all", "active": true, "origin_id": 29, "origin": "Facebook ADS", "reference": "R55", "gender": "M", "approved": true, "juridical": "F", "tax_id": 57157949008, "tag": [ 1182 ], "rg": "45.461.713-6", "rg_emmiter": "ssp", "rg_dispatcher": "2011-09-08", "cnh": 43375783744, "nationality": "Brasileira", "naturality": "Riosulense", "birthplace": "Riosulense", "birth_date": "2011-09-08", "marital": "married", "spouse_id": 5, "legal_representative_id": 80, "contacted_at": "2021-03-22 11:31:00", "last_contact_at": "2021-03-22 11:31:00", "father_name": "Rog\u00e9rio", "mother_name": "Maria", "occupation_id": 10, "occupation": "Corretor imobili\u00e1rio", "employment_link": "EMP", "employment_business": "Apresenta.me", "employment_time": 6, "employment_phone": "+55 47 98420-8674", "employment_address": "Rua Jos\u00e9 Debieux", "income": "1500.00", "income_other": "600.00", "notes": "Entrou em contato pelo Facebook", "company_name": "Apresenta.me", "state_inscription_type": "immune", "state_inscription": 361944136227, "municipal_inscription": 361944136227, "login_date": "2021-03-17 15:50:22", "login_active": true, "login": "carlos_oliveira", "password": "senha@senha3412", "financial_alert": true, "create_building_alert": true }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/persons" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Carlos Ciclano\",
    \"responsible\": [
        3,
        5
    ],
    \"type\": null,
    \"access\": \"all\",
    \"active\": true,
    \"origin_id\": 29,
    \"origin\": \"Facebook ADS\",
    \"reference\": \"R55\",
    \"gender\": \"M\",
    \"approved\": true,
    \"juridical\": \"F\",
    \"tax_id\": 57157949008,
    \"tag\": [
        1182
    ],
    \"rg\": \"45.461.713-6\",
    \"rg_emmiter\": \"ssp\",
    \"rg_dispatcher\": \"2011-09-08\",
    \"cnh\": 43375783744,
    \"nationality\": \"Brasileira\",
    \"naturality\": \"Riosulense\",
    \"birthplace\": \"Riosulense\",
    \"birth_date\": \"2011-09-08\",
    \"marital\": \"married\",
    \"spouse_id\": 5,
    \"legal_representative_id\": 80,
    \"contacted_at\": \"2021-03-22 11:31:00\",
    \"last_contact_at\": \"2021-03-22 11:31:00\",
    \"father_name\": \"Rogério\",
    \"mother_name\": \"Maria\",
    \"occupation_id\": 10,
    \"occupation\": \"Corretor imobiliário\",
    \"employment_link\": \"EMP\",
    \"employment_business\": \"Apresenta.me\",
    \"employment_time\": 6,
    \"employment_phone\": \"+55 47 98420-8674\",
    \"employment_address\": \"Rua José Debieux\",
    \"income\": \"1500.00\",
    \"income_other\": \"600.00\",
    \"notes\": \"Entrou em contato pelo Facebook\",
    \"company_name\": \"Apresenta.me\",
    \"state_inscription_type\": \"immune\",
    \"state_inscription\": 361944136227,
    \"municipal_inscription\": 361944136227,
    \"login_date\": \"2021-03-17 15:50:22\",
    \"login_active\": true,
    \"login\": \"carlos_oliveira\",
    \"password\": \"senha@senha3412\",
    \"financial_alert\": true,
    \"create_building_alert\": true
}"

const url = new URL(
    "https://api.apresenta.me/persons"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Carlos Ciclano",
    "responsible": [
        3,
        5
    ],
    "type": null,
    "access": "all",
    "active": true,
    "origin_id": 29,
    "origin": "Facebook ADS",
    "reference": "R55",
    "gender": "M",
    "approved": true,
    "juridical": "F",
    "tax_id": 57157949008,
    "tag": [
        1182
    ],
    "rg": "45.461.713-6",
    "rg_emmiter": "ssp",
    "rg_dispatcher": "2011-09-08",
    "cnh": 43375783744,
    "nationality": "Brasileira",
    "naturality": "Riosulense",
    "birthplace": "Riosulense",
    "birth_date": "2011-09-08",
    "marital": "married",
    "spouse_id": 5,
    "legal_representative_id": 80,
    "contacted_at": "2021-03-22 11:31:00",
    "last_contact_at": "2021-03-22 11:31:00",
    "father_name": "Rogério",
    "mother_name": "Maria",
    "occupation_id": 10,
    "occupation": "Corretor imobiliário",
    "employment_link": "EMP",
    "employment_business": "Apresenta.me",
    "employment_time": 6,
    "employment_phone": "+55 47 98420-8674",
    "employment_address": "Rua José Debieux",
    "income": "1500.00",
    "income_other": "600.00",
    "notes": "Entrou em contato pelo Facebook",
    "company_name": "Apresenta.me",
    "state_inscription_type": "immune",
    "state_inscription": 361944136227,
    "municipal_inscription": 361944136227,
    "login_date": "2021-03-17 15:50:22",
    "login_active": true,
    "login": "carlos_oliveira",
    "password": "senha@senha3412",
    "financial_alert": true,
    "create_building_alert": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/persons';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Carlos Ciclano',
            'responsible' => [
                3,
                5,
            ],
            'type' => null,
            'access' => 'all',
            'active' => true,
            'origin_id' => 29,
            'origin' => 'Facebook ADS',
            'reference' => 'R55',
            'gender' => 'M',
            'approved' => true,
            'juridical' => 'F',
            'tax_id' => 57157949008,
            'tag' => [
                1182,
            ],
            'rg' => '45.461.713-6',
            'rg_emmiter' => 'ssp',
            'rg_dispatcher' => '2011-09-08',
            'cnh' => 43375783744,
            'nationality' => 'Brasileira',
            'naturality' => 'Riosulense',
            'birthplace' => 'Riosulense',
            'birth_date' => '2011-09-08',
            'marital' => 'married',
            'spouse_id' => 5,
            'legal_representative_id' => 80,
            'contacted_at' => '2021-03-22 11:31:00',
            'last_contact_at' => '2021-03-22 11:31:00',
            'father_name' => 'Rogério',
            'mother_name' => 'Maria',
            'occupation_id' => 10,
            'occupation' => 'Corretor imobiliário',
            'employment_link' => 'EMP',
            'employment_business' => 'Apresenta.me',
            'employment_time' => 6,
            'employment_phone' => '+55 47 98420-8674',
            'employment_address' => 'Rua José Debieux',
            'income' => '1500.00',
            'income_other' => '600.00',
            'notes' => 'Entrou em contato pelo Facebook',
            'company_name' => 'Apresenta.me',
            'state_inscription_type' => 'immune',
            'state_inscription' => 361944136227,
            'municipal_inscription' => 361944136227,
            'login_date' => '2021-03-17 15:50:22',
            'login_active' => true,
            'login' => 'carlos_oliveira',
            'password' => 'senha@senha3412',
            'financial_alert' => true,
            'create_building_alert' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.apresenta.me/persons'
payload = {
    "name": "Carlos Ciclano",
    "responsible": [
        3,
        5
    ],
    "type": null,
    "access": "all",
    "active": true,
    "origin_id": 29,
    "origin": "Facebook ADS",
    "reference": "R55",
    "gender": "M",
    "approved": true,
    "juridical": "F",
    "tax_id": 57157949008,
    "tag": [
        1182
    ],
    "rg": "45.461.713-6",
    "rg_emmiter": "ssp",
    "rg_dispatcher": "2011-09-08",
    "cnh": 43375783744,
    "nationality": "Brasileira",
    "naturality": "Riosulense",
    "birthplace": "Riosulense",
    "birth_date": "2011-09-08",
    "marital": "married",
    "spouse_id": 5,
    "legal_representative_id": 80,
    "contacted_at": "2021-03-22 11:31:00",
    "last_contact_at": "2021-03-22 11:31:00",
    "father_name": "Rogério",
    "mother_name": "Maria",
    "occupation_id": 10,
    "occupation": "Corretor imobiliário",
    "employment_link": "EMP",
    "employment_business": "Apresenta.me",
    "employment_time": 6,
    "employment_phone": "+55 47 98420-8674",
    "employment_address": "Rua José Debieux",
    "income": "1500.00",
    "income_other": "600.00",
    "notes": "Entrou em contato pelo Facebook",
    "company_name": "Apresenta.me",
    "state_inscription_type": "immune",
    "state_inscription": 361944136227,
    "municipal_inscription": 361944136227,
    "login_date": "2021-03-17 15:50:22",
    "login_active": true,
    "login": "carlos_oliveira",
    "password": "senha@senha3412",
    "financial_alert": true,
    "create_building_alert": true
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Obter

GET

https://api.apresenta.me/persons/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da pessoa

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,tax_id

include[contacts]

string

Retorna os contatos da pessoa.

Example:

phone,email

include[contact]

string

Retorna o contato principal da pessoa.

Example:

phone,email

include[apbank]

string

Retorna conta ApBank da pessoa.

Example:

id,name

include[spouse]

string

Retorna os dados do cônjuge.

Example:

id,name

include[bankAccounts]

string

Retorna as contas da pessoa.

Example:

id,description

include[bankAccount]

string

Retorna a conta principal ativa.

Example:

id,description

include[occupation]

string

Retorna a profissão da pessoa.

Example:

id,name

include[buildings]

string

Retorna os dados dos negócios em que a pessoa é cliente.

Example:

id,title

include[contractTenant]

string

Retorna os contratos em que a pessoa é inquilina.

Example:

id,building_id,type

include[contractTenantRent]

string

Retorna os contratos em que a pessoa é inquilina de aluguel.

Example:

id,building_id

include[contractOwner]

string

Retorna os contratos em que a pessoa é proprietária.

Example:

id,building_id

include[tickets]

string

Retorna os tickets da pessoa.

Example:

id,title

include[deals]

string

Retorna os dados dos negócios em que a pessoa é cliente.

Example:

id,title

include[origin]

string

Retorna os dados da origem da pessoa

Example:

rerum

include[tags]

string

Retorna as Tags da pessoa

Example:

vel

include[responsibles]

string

Retorna as pessoas que esta pessoa é responsável.

Example:

id,name

include[responsibleGroups]

string

Retorna os grupos de usuário.

Example:

id,name

include[legalRepresentative]

string

Retorna o Representante legal.

Example:

id,name

include[image]

string

Retorna as imagens.

Example:

id,file_name

include[files]

string

Retorna os arquivos.

Example:

id,file_name

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/persons/13?sort=id&fields=id%2Cname%2Ctax_id&include%5Bcontacts%5D=phone%2Cemail&include%5Bcontact%5D=phone%2Cemail&include%5Bapbank%5D=id%2Cname&include%5Bspouse%5D=id%2Cname&include%5BbankAccounts%5D=id%2Cdescription&include%5BbankAccount%5D=id%2Cdescription&include%5Boccupation%5D=id%2Cname&include%5Bbuildings%5D=id%2Ctitle&include%5BcontractTenant%5D=id%2Cbuilding_id%2Ctype&include%5BcontractTenantRent%5D=id%2Cbuilding_id&include%5BcontractOwner%5D=id%2Cbuilding_id&include%5Btickets%5D=id%2Ctitle&include%5Bdeals%5D=id%2Ctitle&include%5Borigin%5D=rerum&include%5Btags%5D=vel&include%5Bresponsibles%5D=id%2Cname&include%5BresponsibleGroups%5D=id%2Cname&include%5BlegalRepresentative%5D=id%2Cname&include%5Bimage%5D=id%2Cfile_name&include%5Bfiles%5D=id%2Cfile_name" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/persons/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id da pessoa

Example:

Body Parameters

name

string

Nome da pessoa.

Example:

Carlos Ciclano

responsible

string[]

Usuários responsáveis.

Example:

[3,5]

type

string[]

Vínculo com a imobiliária.

access

string

Tipo de acesso à pessoa.

Example:

all

active

boolean

Status.

Example:

origin_id

integer

ID da origem.

Example:

origin

string

Origem da pessoa, caso não saiba o ID.

Example:

Facebook ADS

reference

string

Referência.

Example:

R55

gender

string

Gênero.

Example:

approved

boolean

Aprovada.

Example:

juridical

string

Tipo de cadastro de pessoa (física, jurídica).

Example:

tax_id

integer

CPF/CNPJ.

Example:

57157949008

tag

string[]

Tags.

Example:

[1182]

string

RG.

Example:

45.461.713-6

rg_emmiter

string

Emissor do RG.

Example:

ssp

rg_dispatcher

date

Data de emissão do RG

Example:

2011-09-08

cnh

integer

CNH.

Example:

43375783744

nationality

string

Nacionalidade.

Example:

Brasileira

naturality

string

Naturalidade.

Example:

Riosulense

birthplace

string

Local de nascimento.

Example:

Riosulense

birth_date

date

Data de nascimento.

Example:

2011-09-08

marital

string

Estado civil.

Example:

married

spouse_id

integer

ID do Cônjuge.

Example:

legal_representative_id

integer

Representante legal.

Example:

contacted_at

date

Data de contato.

Example:

2021-03-22 11:31:00

last_contact_at

date

Data do último contato.

Example:

2021-03-22 11:31:00

father_name

string

Nome do pai.

Example:

Rogério

mother_name

string

Nome da mãe.

Example:

Maria

occupation_id

integer

ID de profissão .

Example:

occupation

string

Profissão.

Example:

Corretor imobiliário

employment_link

string

Vínculo empregatício.

Example:

EMP

employment_business

string

Nome da empresa de trabalho.

Example:

Apresenta.me

employment_time

integer

Tempo de empresa.

Example:

employment_phone

string

Telefone da empresa.

Example:

+55 47 98420-8674

employment_address

string

Endereço da empresa.

Example:

Rua José Debieux

income

numeric

Renda.

Example:

1500.00

income_other

Outras

rendas.

Example:

600.00

notes

string

Observações.

Example:

Entrou em contato pelo Facebook

company_name

string

Razão social.

Example:

Apresenta.me

state_inscription_type

string

Indicador IE.

Example:

immune

state_inscription

integer

Inscrição estadual (IE).

Example:

361944136227

municipal_inscription

integer

Inscrição Municipal (IM).

Example:

361944136227

login_date

date

Data do último login.

Example:

2021-03-17 15:50:22

login_active

boolean

Example:

string

Example:

carlos_oliveira

password

string

Senha.

Example:

senha@senha3412

financial_alert

boolean

Alerta financeiro habilitado.

Example:

create_building_alert

boolean

Alerta cadastro de imóvel habilitado.

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/persons/13" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Carlos Ciclano\",
    \"responsible\": [
        3,
        5
    ],
    \"type\": null,
    \"access\": \"all\",
    \"active\": true,
    \"origin_id\": 29,
    \"origin\": \"Facebook ADS\",
    \"reference\": \"R55\",
    \"gender\": \"M\",
    \"approved\": true,
    \"juridical\": \"F\",
    \"tax_id\": 57157949008,
    \"tag\": [
        1182
    ],
    \"rg\": \"45.461.713-6\",
    \"rg_emmiter\": \"ssp\",
    \"rg_dispatcher\": \"2011-09-08\",
    \"cnh\": 43375783744,
    \"nationality\": \"Brasileira\",
    \"naturality\": \"Riosulense\",
    \"birthplace\": \"Riosulense\",
    \"birth_date\": \"2011-09-08\",
    \"marital\": \"married\",
    \"spouse_id\": 5,
    \"legal_representative_id\": 80,
    \"contacted_at\": \"2021-03-22 11:31:00\",
    \"last_contact_at\": \"2021-03-22 11:31:00\",
    \"father_name\": \"Rogério\",
    \"mother_name\": \"Maria\",
    \"occupation_id\": 10,
    \"occupation\": \"Corretor imobiliário\",
    \"employment_link\": \"EMP\",
    \"employment_business\": \"Apresenta.me\",
    \"employment_time\": 6,
    \"employment_phone\": \"+55 47 98420-8674\",
    \"employment_address\": \"Rua José Debieux\",
    \"income\": \"1500.00\",
    \"income_other\": \"600.00\",
    \"notes\": \"Entrou em contato pelo Facebook\",
    \"company_name\": \"Apresenta.me\",
    \"state_inscription_type\": \"immune\",
    \"state_inscription\": 361944136227,
    \"municipal_inscription\": 361944136227,
    \"login_date\": \"2021-03-17 15:50:22\",
    \"login_active\": true,
    \"login\": \"carlos_oliveira\",
    \"password\": \"senha@senha3412\",
    \"financial_alert\": true,
    \"create_building_alert\": true
}"

const url = new URL(
    "https://api.apresenta.me/persons/13"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Carlos Ciclano",
    "responsible": [
        3,
        5
    ],
    "type": null,
    "access": "all",
    "active": true,
    "origin_id": 29,
    "origin": "Facebook ADS",
    "reference": "R55",
    "gender": "M",
    "approved": true,
    "juridical": "F",
    "tax_id": 57157949008,
    "tag": [
        1182
    ],
    "rg": "45.461.713-6",
    "rg_emmiter": "ssp",
    "rg_dispatcher": "2011-09-08",
    "cnh": 43375783744,
    "nationality": "Brasileira",
    "naturality": "Riosulense",
    "birthplace": "Riosulense",
    "birth_date": "2011-09-08",
    "marital": "married",
    "spouse_id": 5,
    "legal_representative_id": 80,
    "contacted_at": "2021-03-22 11:31:00",
    "last_contact_at": "2021-03-22 11:31:00",
    "father_name": "Rogério",
    "mother_name": "Maria",
    "occupation_id": 10,
    "occupation": "Corretor imobiliário",
    "employment_link": "EMP",
    "employment_business": "Apresenta.me",
    "employment_time": 6,
    "employment_phone": "+55 47 98420-8674",
    "employment_address": "Rua José Debieux",
    "income": "1500.00",
    "income_other": "600.00",
    "notes": "Entrou em contato pelo Facebook",
    "company_name": "Apresenta.me",
    "state_inscription_type": "immune",
    "state_inscription": 361944136227,
    "municipal_inscription": 361944136227,
    "login_date": "2021-03-17 15:50:22",
    "login_active": true,
    "login": "carlos_oliveira",
    "password": "senha@senha3412",
    "financial_alert": true,
    "create_building_alert": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/persons/13';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Carlos Ciclano',
            'responsible' => [
                3,
                5,
            ],
            'type' => null,
            'access' => 'all',
            'active' => true,
            'origin_id' => 29,
            'origin' => 'Facebook ADS',
            'reference' => 'R55',
            'gender' => 'M',
            'approved' => true,
            'juridical' => 'F',
            'tax_id' => 57157949008,
            'tag' => [
                1182,
            ],
            'rg' => '45.461.713-6',
            'rg_emmiter' => 'ssp',
            'rg_dispatcher' => '2011-09-08',
            'cnh' => 43375783744,
            'nationality' => 'Brasileira',
            'naturality' => 'Riosulense',
            'birthplace' => 'Riosulense',
            'birth_date' => '2011-09-08',
            'marital' => 'married',
            'spouse_id' => 5,
            'legal_representative_id' => 80,
            'contacted_at' => '2021-03-22 11:31:00',
            'last_contact_at' => '2021-03-22 11:31:00',
            'father_name' => 'Rogério',
            'mother_name' => 'Maria',
            'occupation_id' => 10,
            'occupation' => 'Corretor imobiliário',
            'employment_link' => 'EMP',
            'employment_business' => 'Apresenta.me',
            'employment_time' => 6,
            'employment_phone' => '+55 47 98420-8674',
            'employment_address' => 'Rua José Debieux',
            'income' => '1500.00',
            'income_other' => '600.00',
            'notes' => 'Entrou em contato pelo Facebook',
            'company_name' => 'Apresenta.me',
            'state_inscription_type' => 'immune',
            'state_inscription' => 361944136227,
            'municipal_inscription' => 361944136227,
            'login_date' => '2021-03-17 15:50:22',
            'login_active' => true,
            'login' => 'carlos_oliveira',
            'password' => 'senha@senha3412',
            'financial_alert' => true,
            'create_building_alert' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.apresenta.me/persons/13'
payload = {
    "name": "Carlos Ciclano",
    "responsible": [
        3,
        5
    ],
    "type": null,
    "access": "all",
    "active": true,
    "origin_id": 29,
    "origin": "Facebook ADS",
    "reference": "R55",
    "gender": "M",
    "approved": true,
    "juridical": "F",
    "tax_id": 57157949008,
    "tag": [
        1182
    ],
    "rg": "45.461.713-6",
    "rg_emmiter": "ssp",
    "rg_dispatcher": "2011-09-08",
    "cnh": 43375783744,
    "nationality": "Brasileira",
    "naturality": "Riosulense",
    "birthplace": "Riosulense",
    "birth_date": "2011-09-08",
    "marital": "married",
    "spouse_id": 5,
    "legal_representative_id": 80,
    "contacted_at": "2021-03-22 11:31:00",
    "last_contact_at": "2021-03-22 11:31:00",
    "father_name": "Rogério",
    "mother_name": "Maria",
    "occupation_id": 10,
    "occupation": "Corretor imobiliário",
    "employment_link": "EMP",
    "employment_business": "Apresenta.me",
    "employment_time": 6,
    "employment_phone": "+55 47 98420-8674",
    "employment_address": "Rua José Debieux",
    "income": "1500.00",
    "income_other": "600.00",
    "notes": "Entrou em contato pelo Facebook",
    "company_name": "Apresenta.me",
    "state_inscription_type": "immune",
    "state_inscription": 361944136227,
    "municipal_inscription": 361944136227,
    "login_date": "2021-03-17 15:50:22",
    "login_active": true,
    "login": "carlos_oliveira",
    "password": "senha@senha3412",
    "financial_alert": true,
    "create_building_alert": true
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Excluir

DELETE

https://api.apresenta.me/persons/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da pessoa

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/persons/15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Profissões

Pesquisar

GET

https://api.apresenta.me/persons/occupations

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name

filter[id]

string

ID da profissão.

Example:

123

filter[name]

string

Nome da profissão.

Example:

%Açougueiro%

filter[reference]

string

Referência da profissão.

Example:

%Frigorífico%

include[persons]

string

Retorna as pessoas vinculadas à profissão.

Example:

id,name,gender

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/persons/occupations?sort=id&fields=id%2Cname&filter%5Bid%5D=123&filter%5Bname%5D=%25A%C3%A7ougueiro%25&filter%5Breference%5D=%25Frigor%C3%ADfico%25&include%5Bpersons%5D=id%2Cname%2Cgender" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Obter

GET

https://api.apresenta.me/persons/occupations/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da Profissão

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name

include[persons]

string

Retorna as pessoas vinculadas à profissão.

Example:

id,name,gender

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/persons/occupations/7?sort=id&fields=id%2Cname&include%5Bpersons%5D=id%2Cname%2Cgender" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Contatos

Pesquisar

GET

https://api.apresenta.me/persons/{person_id}/contacts

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

person_id

integer

ID da Pessoa

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name

filter[id]

integer

ID do contato.

Example:

filter[person_id]

integer

Pessoa.

Example:

123

filter[country_id]

integer

País.

Example:

filter[state_id]

integer

Estado.

Example:

filter[city_id]

integer

Cidade.

Example:

filter[district_id]

integer

Bairro.

Example:

filter[zip_code]

integer

CEP.

Example:

89160000

filter[street]

string

Rua.

Example:

%Rua México%

filter[number]

string

Número.

Example:

1090

filter[complement]

string

Complemento de endereço.

Example:

Casa

filter[description]

string

Descrição.

Example:

Marcelo

filter[cellphone]

string

Celular.

Example:

47988888888

filter[phone]

string

Telefone.

Example:

4735310000

filter[email]

string

E-mail.

Example:

mail@example.com

filter[principal]

boolean

Contato Principal.

Example:

filter[financial]

boolean

Contato Financeiro.

include[person]

string

Retorna os dados da pessoa.

Example:

id,name

include[country]

string

Retorna os dados do país.

Example:

id,abbreviation

include[city]

string

Retorna os dados da cidade.

Example:

id,name

include[state]

string

Retorna os dados do estado.

Example:

id,name,abbreviation

include[district]

string

Retorna os dados do bairro.

Example:

id,name

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/persons/16/contacts?sort=id&fields=id%2Cname&filter%5Bid%5D=1&filter%5Bperson_id%5D=123&filter%5Bcountry_id%5D=1&filter%5Bstate_id%5D=24&filter%5Bcity_id%5D=3&filter%5Bdistrict_id%5D=12&filter%5Bzip_code%5D=89160000&filter%5Bstreet%5D=%25Rua+M%C3%A9xico%25&filter%5Bnumber%5D=1090&filter%5Bcomplement%5D=Casa&filter%5Bdescription%5D=Marcelo&filter%5Bcellphone%5D=47988888888&filter%5Bphone%5D=4735310000&filter%5Bemail%5D=mail%40example.com&filter%5Bprincipal%5D=1&filter%5Bfinancial%5D=&include%5Bperson%5D=id%2Cname&include%5Bcountry%5D=id%2Cabbreviation&include%5Bcity%5D=id%2Cname&include%5Bstate%5D=id%2Cname%2Cabbreviation&include%5Bdistrict%5D=id%2Cname" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/persons/{person_id}/contacts

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

person_id

string

required

The ID of the person.

Example:

non

Body Parameters

person_id

integer

required

ID da Pessoa.

Example:

123

country_id

integer

ID do País.

Example:

state_id

integer

ID do Estado.

Example:

city_id

integer

ID do Cidade.

Example:

district_id

integer

ID do Bairro.

Example:

zip_code

integer

CEP.

Example:

89160000

street

string

Rua.

Example:

%Rua México%

number

string

Número.

Example:

1090

complement

string

Complemento de endereço.

Example:

Casa

description

string

Descrição.

Example:

Marcelo

cellphone

string

Celular.

Example:

47988888888

phone

string

Telefone.

Example:

4735310000

string

E-mail.

Example:

mail@example.com

principal

boolean

Contato Principal.

Example:

financial

boolean

Contato Financeiro.

Auth

Bearer

Headers

URL Parameters

Body

{ "person_id": 123, "country_id": 1, "state_id": 24, "city_id": 3, "district_id": 12, "zip_code": 89160000, "street": "%Rua M\u00e9xico%", "number": "1090", "complement": "Casa", "description": "Marcelo", "cellphone": "47988888888", "phone": "4735310000", "email": "mail@example.com", "principal": true, "financial": false }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/persons/non/contacts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"person_id\": 123,
    \"country_id\": 1,
    \"state_id\": 24,
    \"city_id\": 3,
    \"district_id\": 12,
    \"zip_code\": 89160000,
    \"street\": \"%Rua México%\",
    \"number\": \"1090\",
    \"complement\": \"Casa\",
    \"description\": \"Marcelo\",
    \"cellphone\": \"47988888888\",
    \"phone\": \"4735310000\",
    \"email\": \"mail@example.com\",
    \"principal\": true,
    \"financial\": false
}"

Obter

GET

https://api.apresenta.me/persons/{person_id}/contacts/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

person_id

integer

required

ID da Pessoa

Example:

integer

required

ID do contato

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name

include[person]

string

Retorna os dados da pessoa.

Example:

id,name

include[country]

string

Retorna os dados do país.

Example:

id,abbreviation

include[city]

string

Retorna os dados da cidade.

Example:

id,name

include[state]

string

Retorna os dados do estado.

Example:

id,name,abbreviation

include[district]

string

Retorna os dados do bairro.

Example:

id,name

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/persons/13/contacts/3?sort=id&fields=id%2Cname&include%5Bperson%5D=id%2Cname&include%5Bcountry%5D=id%2Cabbreviation&include%5Bcity%5D=id%2Cname&include%5Bstate%5D=id%2Cname%2Cabbreviation&include%5Bdistrict%5D=id%2Cname" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/persons/{person_id}/contacts/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

person_id

integer

required

Id da Pessoa

Example:

integer

required

Id do contato

Example:

Body Parameters

country_id

integer

ID do País.

Example:

state_id

integer

ID do Estado.

Example:

city_id

integer

ID do Cidade.

Example:

district_id

integer

ID do Bairro.

Example:

zip_code

integer

CEP.

Example:

89160000

street

string

Rua.

Example:

%Rua México%

number

string

Número.

Example:

1090

complement

string

Complemento de endereço.

Example:

Casa

description

string

Descrição.

Example:

Marcelo

cellphone

string

Celular.

Example:

47988888888

phone

string

Telefone.

Example:

4735310000

string

E-mail.

Example:

mail@example.com

principal

boolean

Contato Principal.

Example:

financial

boolean

Contato Financeiro.

Auth

Bearer

Headers

URL Parameters

Body

{ "country_id": 1, "state_id": 24, "city_id": 3, "district_id": 12, "zip_code": 89160000, "street": "%Rua M\u00e9xico%", "number": "1090", "complement": "Casa", "description": "Marcelo", "cellphone": "47988888888", "phone": "4735310000", "email": "mail@example.com", "principal": true, "financial": false }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/persons/7/contacts/12" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"country_id\": 1,
    \"state_id\": 24,
    \"city_id\": 3,
    \"district_id\": 12,
    \"zip_code\": 89160000,
    \"street\": \"%Rua México%\",
    \"number\": \"1090\",
    \"complement\": \"Casa\",
    \"description\": \"Marcelo\",
    \"cellphone\": \"47988888888\",
    \"phone\": \"4735310000\",
    \"email\": \"mail@example.com\",
    \"principal\": true,
    \"financial\": false
}"

Excluir

DELETE

https://api.apresenta.me/persons/{person_id}/contacts/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

person_id

integer

ID da Pessoa

Example:

integer

required

ID do contato

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/persons/18/contacts/9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Contas Bancárias

Pesquisar

GET

https://api.apresenta.me/persons/{person_id}/bankAccounts

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

person_id

integer

ID da Pessoa

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name

filter[id]

integer

ID da conta.

Example:

123

filter[person_id]

integer

ID da Pessoa.

Example:

321

filter[description]

string

Descrição.

Example:

Itaú

filter[holder]

string

Nome do titular.

Example:

Ciclano Fulano

filter[person_type]

string

Tipo de Pessoa (física ou jurídica)

Example:

filter[tax_id]

integer

CPF/CNPJ: 99999999999

Example:

filter[birth_date]

string

date Data de Nascimento.

Example:

1999-06-09

filter[type]

string

Tipo da Conta.

Example:

filter[pix_type]

string

Tipo da chave PIX.

Example:

filter[pix_key]

string

Chave PIX.

Example:

mail@example.com

filter[bank]

integer

Código do Banco.

Example:

260

filter[agency]

string

Agência.

Example:

0223

filter[account]

string

Conta.

Example:

2140104-7

filter[principal]

boolean

Conta principal.

Example:

filter[active]

boolean

Status da conta.

Example:

include[person]

string

Retorna os dados da pessoa.

Example:

id,name

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/persons/11/bankAccounts?sort=id&fields=id%2Cname&filter%5Bid%5D=123&filter%5Bperson_id%5D=321&filter%5Bdescription%5D=Ita%C3%BA&filter%5Bholder%5D=Ciclano+Fulano&filter%5Bperson_type%5D=J&filter%5Btax_id%5D=17&filter%5Bbirth_date%5D=1999-06-09&filter%5Btype%5D=CC&filter%5Bpix_type%5D=email&filter%5Bpix_key%5D=mail%40example.com&filter%5Bbank%5D=260&filter%5Bagency%5D=0223&filter%5Baccount%5D=2140104-7&filter%5Bprincipal%5D=1&filter%5Bactive%5D=1&include%5Bperson%5D=id%2Cname" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/persons/{person_id}/bankAccounts

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

person_id

integer

ID da Pessoa

Example:

Body Parameters

person_id

integer

ID da Pessoa.

Example:

321

description

string

Descrição.

Example:

Itaú

holder

string

Nome do titular.

Example:

Ciclano Fulano

person_type

string

Tipo de Pessoa (física ou jurídica)

Example:

tax_id

integer

CPF/CNPJ: 99999999999

Example:

birth_date

date

Data de Nascimento.

Example:

1999-06-09

type

string

Tipo da Conta.

Example:

pix_type

string

Tipo da chave PIX.

Example:

pix_key

string

Chave PIX.

Example:

mail@example.com

bank

integer

Código do Banco.

Example:

260

agency

string

Agência.

Example:

0223

account

string

Conta.

Example:

2140104-7

principal

boolean

Conta principal.

Example:

active

boolean

Status da conta.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "person_id": 321, "description": "Ita\u00fa", "holder": "Ciclano Fulano", "person_type": "J", "tax_id": 3, "birth_date": "1999-06-09", "type": "CC", "pix_type": "email", "pix_key": "mail@example.com", "bank": 260, "agency": "0223", "account": "2140104-7", "principal": true, "active": true }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/persons/14/bankAccounts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"person_id\": 321,
    \"description\": \"Itaú\",
    \"holder\": \"Ciclano Fulano\",
    \"person_type\": \"J\",
    \"tax_id\": 3,
    \"birth_date\": \"1999-06-09\",
    \"type\": \"CC\",
    \"pix_type\": \"email\",
    \"pix_key\": \"mail@example.com\",
    \"bank\": 260,
    \"agency\": \"0223\",
    \"account\": \"2140104-7\",
    \"principal\": true,
    \"active\": true
}"

Obter

GET

https://api.apresenta.me/persons/{person_id}/bankAccounts/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

person_id

string

required

int ID da Pessoa

Example:

animi

integer

required

ID da Conta Bancária

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name

include[person]

string

Retorna os dados da pessoa.

Example:

id,name

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/persons/animi/bankAccounts/3?sort=id&fields=id%2Cname&include%5Bperson%5D=id%2Cname" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/persons/{person_id}/bankAccounts/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

person_id

integer

required

ID da Pessoa

Example:

integer

required

ID da Conta Bancária

Example:

Body Parameters

person_id

integer

ID da Pessoa.

Example:

321

description

string

Descrição.

Example:

Itaú

holder

string

Nome do titular.

Example:

Ciclano Fulano

person_type

string

Tipo de Pessoa (física ou jurídica)

Example:

tax_id

integer

CPF/CNPJ: 99999999999

Example:

birth_date

date

Data de Nascimento.

Example:

1999-06-09

type

string

Tipo da Conta.

Example:

pix_type

string

Tipo da chave PIX.

Example:

pix_key

string

Chave PIX.

Example:

mail@example.com

bank

integer

Código do Banco.

Example:

260

agency

string

Agência.

Example:

0223

account

string

Conta.

Example:

2140104-7

principal

boolean

Conta principal.

Example:

active

boolean

Status da conta.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "person_id": 321, "description": "Ita\u00fa", "holder": "Ciclano Fulano", "person_type": "J", "tax_id": 11, "birth_date": "1999-06-09", "type": "CC", "pix_type": "email", "pix_key": "mail@example.com", "bank": 260, "agency": "0223", "account": "2140104-7", "principal": true, "active": true }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/persons/11/bankAccounts/10" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"person_id\": 321,
    \"description\": \"Itaú\",
    \"holder\": \"Ciclano Fulano\",
    \"person_type\": \"J\",
    \"tax_id\": 11,
    \"birth_date\": \"1999-06-09\",
    \"type\": \"CC\",
    \"pix_type\": \"email\",
    \"pix_key\": \"mail@example.com\",
    \"bank\": 260,
    \"agency\": \"0223\",
    \"account\": \"2140104-7\",
    \"principal\": true,
    \"active\": true
}"

Excluir

DELETE

https://api.apresenta.me/persons/{person_id}/bankAccounts/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

person_id

integer

required

ID da Pessoa

Example:

integer

required

ID da Conta Bancária

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/persons/5/bankAccounts/18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Propostas

GET

https://api.apresenta.me/deals/statistics/{widget}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

widget

string

required

Example:

numquam

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/deals/statistics/numquam" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Regras para Rodízio de Leads

Pesquisar

GET

https://api.apresenta.me/deals/rotations

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

order

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,interest,type

filter[id]

integer

ID da regra de rodízio.

Example:

filter[funnel_step_id]

integer

ID do Funil e etapa para encaminhar o lead.

Example:

filter[funnel_step_mix]

integer

ID do Funil e etapa para encaminhar o lead Mesclado.

Example:

filter[name]

string

Nome da regra.

Example:

carlos%

filter[interest]

string[]

Interesses do lead.

filter[origin]

integer

ID da Origem do Lead: 1

Example:

filter[user]

integer[]

ID dos Corretores

Example:

[123,456]

filter[type]

string

Tipo de rodízio (roleta).

Example:

users

filter[building]

integer[]

Imóveis específicos.

Example:

[123,345]

filter[building_type]

integer[]

Tipo de Imóvel.

Example:

[1,2]

filter[detail]

integer[]

Detalhes do imóvel.

Example:

[123,321]

filter[price_min]

string

Preço mínimo do imóvel.

Example:

1200.00

filter[price_max]

string

Preço máximo do imóvel.

Example:

1500.00

filter[state]

integer

Estado.

Example:

filter[city]

integer

Cidade.

Example:

filter[district]

integer

Bairro.

Example:

filter[active]

boolean

Status.

Example:

filter[position]

integer

Ordem da regra.

Example:

filter[limit_security_user]

integer

Limite de Segurança.

Example:

filter[with_security_user]

boolean

Com Corretor de Segurança.

Example:

filter[security_user]

integer[]

Corretor de Segurança.

Example:

[12]

filter[send_lead_center]

boolean

Enviar para o Bolsão de Leads.

Example:

filter[responsible_respect]

boolean

Se o lead já tiver atendimento ou já possuir um responsável, repassá-lo para o mesmo corretor.

Example:

filter[responsible_respect_only_rule]

boolean

Respeitar o atendimento ao mesmo corretor apenas se este estiver na regra.

filter[hour_respect]

boolean

Distribuir apenas no horário determinado.

Example:

filter[online_only]

boolean

Distribuir apenas para corretores online.

Example:

filter[with_contact_only]

boolean

Somente Lead com contato.

Example:

filter[skip]

boolean

Pular para próximo corretor do rodízio caso o lead não seja aceito dentro do prazo.

Example:

filter[skip_time]

integer

Tempo para pular para o próximo corretor do rodízio.

Example:

filter[skip_hour_initial]

string

time Horário inicial para rodízio de leads.

Example:

08:00

filter[skip_hour_final]

string

time Horário final para rodízio de leads.

Example:

18:00

filter[catcher_preference]

boolean

Dar preferência ao corretor captador.

filter[pickup_user]

integer

Corretor captador.

Example:

123

filter[pickup_user_expiration]

integer

Enviar exclusivamente para o corretor captador (0-6).

Example:

filter[days_for_rule]

string[]

Dias de vigência da regra.

filter[from]

string

date Lead criado em.

Example:

2024-01-01

filter[constructor_id]

integer[]

Example:

[1,2,3]

include[funnelStep]

string

Retorna dados da etapa do funil da regra.

Example:

id,title

include[origins]

string

Retorna as origens.

Example:

id,description

include[buildings]

string

Retorna os Imóveis específicos da regra.

Example:

id,title

include[buildingTypes]

string

Retorna os tipos de imóveis da regra.

Example:

id,description

include[constructor_idToJson]

string

Retorna as construtoras.

Example:

id,name

include[details]

string

Retorna os detalhes.

Example:

id,description

include[users]

string

Retorna os usuários.

Example:

id,name,email

include[states]

string

Retorna os estados da regra.

Example:

id,name,abbreviation

include[cities]

string

Retorna as cidades da regra.

Example:

id,name,abbreviation

include[districts]

string

Retorna os bairros da regra.

Example:

id,name

include[pickupUsers]

string

Retorna os corretores captadores.

Example:

id,name

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/deals/rotations?sort=order&fields=id%2Cname%2Cinterest%2Ctype&filter%5Bid%5D=2&filter%5Bfunnel_step_id%5D=1&filter%5Bfunnel_step_mix%5D=2&filter%5Bname%5D=carlos%25&filter%5Binterest%5D=&filter%5Borigin%5D=18&filter%5Buser%5D[]=123&filter%5Buser%5D[]=456&filter%5Btype%5D=users&filter%5Bbuilding%5D[]=123&filter%5Bbuilding%5D[]=345&filter%5Bbuilding_type%5D[]=1&filter%5Bbuilding_type%5D[]=2&filter%5Bdetail%5D[]=123&filter%5Bdetail%5D[]=321&filter%5Bprice_min%5D=1200.00&filter%5Bprice_max%5D=1500.00&filter%5Bstate%5D=1&filter%5Bcity%5D=2&filter%5Bdistrict%5D=3&filter%5Bactive%5D=1&filter%5Bposition%5D=1&filter%5Blimit_security_user%5D=2&filter%5Bwith_security_user%5D=1&filter%5Bsecurity_user%5D[]=12&filter%5Bsend_lead_center%5D=1&filter%5Bresponsible_respect%5D=1&filter%5Bresponsible_respect_only_rule%5D=&filter%5Bhour_respect%5D=1&filter%5Bonline_only%5D=1&filter%5Bwith_contact_only%5D=1&filter%5Bskip%5D=1&filter%5Bskip_time%5D=15&filter%5Bskip_hour_initial%5D=08%3A00&filter%5Bskip_hour_final%5D=18%3A00&filter%5Bcatcher_preference%5D=&filter%5Bpickup_user%5D=123&filter%5Bpickup_user_expiration%5D=0&filter%5Bdays_for_rule%5D=&filter%5Bfrom%5D=2024-01-01&filter%5Bconstructor_id%5D[]=1&filter%5Bconstructor_id%5D[]=2&filter%5Bconstructor_id%5D[]=3&include%5BfunnelStep%5D=id%2Ctitle&include%5Borigins%5D=id%2Cdescription&include%5Bbuildings%5D=id%2Ctitle&include%5BbuildingTypes%5D=id%2Cdescription&include%5Bconstructor_idToJson%5D=id%2Cname&include%5Bdetails%5D=id%2Cdescription&include%5Busers%5D=id%2Cname%2Cemail&include%5Bstates%5D=id%2Cname%2Cabbreviation&include%5Bcities%5D=id%2Cname%2Cabbreviation&include%5Bdistricts%5D=id%2Cname&include%5BpickupUsers%5D=id%2Cname" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://api.apresenta.me/deals/rotations"
);

const params = {
    "sort": "order",
    "fields": "id,name,interest,type",
    "filter[id]": "2",
    "filter[funnel_step_id]": "1",
    "filter[funnel_step_mix]": "2",
    "filter[name]": "carlos%",
    "filter[interest]": "",
    "filter[origin]": "18",
    "filter[user][0]": "123",
    "filter[user][1]": "456",
    "filter[type]": "users",
    "filter[building][0]": "123",
    "filter[building][1]": "345",
    "filter[building_type][0]": "1",
    "filter[building_type][1]": "2",
    "filter[detail][0]": "123",
    "filter[detail][1]": "321",
    "filter[price_min]": "1200.00",
    "filter[price_max]": "1500.00",
    "filter[state]": "1",
    "filter[city]": "2",
    "filter[district]": "3",
    "filter[active]": "1",
    "filter[position]": "1",
    "filter[limit_security_user]": "2",
    "filter[with_security_user]": "1",
    "filter[security_user][0]": "12",
    "filter[send_lead_center]": "1",
    "filter[responsible_respect]": "1",
    "filter[responsible_respect_only_rule]": "0",
    "filter[hour_respect]": "1",
    "filter[online_only]": "1",
    "filter[with_contact_only]": "1",
    "filter[skip]": "1",
    "filter[skip_time]": "15",
    "filter[skip_hour_initial]": "08:00",
    "filter[skip_hour_final]": "18:00",
    "filter[catcher_preference]": "0",
    "filter[pickup_user]": "123",
    "filter[pickup_user_expiration]": "0",
    "filter[days_for_rule]": "",
    "filter[from]": "2024-01-01",
    "filter[constructor_id][0]": "1",
    "filter[constructor_id][1]": "2",
    "filter[constructor_id][2]": "3",
    "include[funnelStep]": "id,title",
    "include[origins]": "id,description",
    "include[buildings]": "id,title",
    "include[buildingTypes]": "id,description",
    "include[constructor_idToJson]": "id,name",
    "include[details]": "id,description",
    "include[users]": "id,name,email",
    "include[states]": "id,name,abbreviation",
    "include[cities]": "id,name,abbreviation",
    "include[districts]": "id,name",
    "include[pickupUsers]": "id,name",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/deals/rotations';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'sort' => 'order',
            'fields' => 'id,name,interest,type',
            'filter[id]' => '2',
            'filter[funnel_step_id]' => '1',
            'filter[funnel_step_mix]' => '2',
            'filter[name]' => 'carlos%',
            'filter[interest]' => '',
            'filter[origin]' => '18',
            'filter[user][0]' => '123',
            'filter[user][1]' => '456',
            'filter[type]' => 'users',
            'filter[building][0]' => '123',
            'filter[building][1]' => '345',
            'filter[building_type][0]' => '1',
            'filter[building_type][1]' => '2',
            'filter[detail][0]' => '123',
            'filter[detail][1]' => '321',
            'filter[price_min]' => '1200.00',
            'filter[price_max]' => '1500.00',
            'filter[state]' => '1',
            'filter[city]' => '2',
            'filter[district]' => '3',
            'filter[active]' => '1',
            'filter[position]' => '1',
            'filter[limit_security_user]' => '2',
            'filter[with_security_user]' => '1',
            'filter[security_user][0]' => '12',
            'filter[send_lead_center]' => '1',
            'filter[responsible_respect]' => '1',
            'filter[responsible_respect_only_rule]' => '0',
            'filter[hour_respect]' => '1',
            'filter[online_only]' => '1',
            'filter[with_contact_only]' => '1',
            'filter[skip]' => '1',
            'filter[skip_time]' => '15',
            'filter[skip_hour_initial]' => '08:00',
            'filter[skip_hour_final]' => '18:00',
            'filter[catcher_preference]' => '0',
            'filter[pickup_user]' => '123',
            'filter[pickup_user_expiration]' => '0',
            'filter[days_for_rule]' => '',
            'filter[from]' => '2024-01-01',
            'filter[constructor_id][0]' => '1',
            'filter[constructor_id][1]' => '2',
            'filter[constructor_id][2]' => '3',
            'include[funnelStep]' => 'id,title',
            'include[origins]' => 'id,description',
            'include[buildings]' => 'id,title',
            'include[buildingTypes]' => 'id,description',
            'include[constructor_idToJson]' => 'id,name',
            'include[details]' => 'id,description',
            'include[users]' => 'id,name,email',
            'include[states]' => 'id,name,abbreviation',
            'include[cities]' => 'id,name,abbreviation',
            'include[districts]' => 'id,name',
            'include[pickupUsers]' => 'id,name',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.apresenta.me/deals/rotations'
params = {
  'sort': 'order',
  'fields': 'id,name,interest,type',
  'filter[id]': '2',
  'filter[funnel_step_id]': '1',
  'filter[funnel_step_mix]': '2',
  'filter[name]': 'carlos%',
  'filter[interest]': '',
  'filter[origin]': '18',
  'filter[user][0]': '123',
  'filter[user][1]': '456',
  'filter[type]': 'users',
  'filter[building][0]': '123',
  'filter[building][1]': '345',
  'filter[building_type][0]': '1',
  'filter[building_type][1]': '2',
  'filter[detail][0]': '123',
  'filter[detail][1]': '321',
  'filter[price_min]': '1200.00',
  'filter[price_max]': '1500.00',
  'filter[state]': '1',
  'filter[city]': '2',
  'filter[district]': '3',
  'filter[active]': '1',
  'filter[position]': '1',
  'filter[limit_security_user]': '2',
  'filter[with_security_user]': '1',
  'filter[security_user][0]': '12',
  'filter[send_lead_center]': '1',
  'filter[responsible_respect]': '1',
  'filter[responsible_respect_only_rule]': '0',
  'filter[hour_respect]': '1',
  'filter[online_only]': '1',
  'filter[with_contact_only]': '1',
  'filter[skip]': '1',
  'filter[skip_time]': '15',
  'filter[skip_hour_initial]': '08:00',
  'filter[skip_hour_final]': '18:00',
  'filter[catcher_preference]': '0',
  'filter[pickup_user]': '123',
  'filter[pickup_user_expiration]': '0',
  'filter[days_for_rule]': '',
  'filter[from]': '2024-01-01',
  'filter[constructor_id][0]': '1',
  'filter[constructor_id][1]': '2',
  'filter[constructor_id][2]': '3',
  'include[funnelStep]': 'id,title',
  'include[origins]': 'id,description',
  'include[buildings]': 'id,title',
  'include[buildingTypes]': 'id,description',
  'include[constructor_idToJson]': 'id,name',
  'include[details]': 'id,description',
  'include[users]': 'id,name,email',
  'include[states]': 'id,name,abbreviation',
  'include[cities]': 'id,name,abbreviation',
  'include[districts]': 'id,name',
  'include[pickupUsers]': 'id,name',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/deals/rotations

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

funnel_step_id

required

int ID do Funil e etapa para encaminhar o lead.

Example:

funnel_step_mix

integer

ID do Funil e etapa para encaminhar o lead Mesclado.

Example:

name

string

required

Nome da regra.

Example:

carlos%

interest

string[]

Interesses do lead.

origin

integer

ID da Origem do Lead: 1

Example:

user

integer[]

ID dos Corretores

Example:

[123,456]

type

string

Tipo de rodízio (roleta).

Example:

users

building

integer[]

Imóveis específicos.

Example:

[123,345]

building_type

integer[]

Tipo de Imóvel.

Example:

[1,2]

detail

integer[]

Detalhes do imóvel.

Example:

[123,321]

price_min

string

Preço mínimo do imóvel.

Example:

1200.00

price_max

Preço

máximo do imóvel.

Example:

1500.00

state

integer

Estado.

Example:

city

integer

Cidade.

Example:

limit_security_user

integer

Limite de Segurança.

Example:

with_security_user

boolean

Com Corretor de Segurança.

Example:

security_user

integer[]

Corretor de Segurança.

Example:

[12]

send_lead_center

boolean

Enviar para o Bolsão de Leads.

Example:

district

integer

Bairro.

Example:

active

boolean

Status.

Example:

position

integer

Ordem da regra.

Example:

responsible_respect

boolean

Se o lead já tiver atendimento ou já possuir um responsável, repassá-lo para o mesmo corretor.

Example:

responsible_respect_only_rule

boolean

Respeitar o atendimento ao mesmo corretor apenas se este estiver na regra.

hour_respect

boolean

Distribuir apenas no horário determinado.

Example:

online_only

boolean

Distribuir apenas para corretores online.

Example:

with_contact_only

boolean

Somente Lead com contato.

Example:

skip

boolean

Pular para próximo corretor do rodízio caso o lead não seja aceito dentro do prazo.

Example:

skip_time

integer

Tempo para pular para o próximo corretor do rodízio.

Example:

skip_hour_initial

time

Horário inicial para rodízio de leads.

Example:

08:00

skip_hour_final

time

Horário final para rodízio de leads.

Example:

18:00

catcher_preference

boolean

Dar preferência ao corretor captador.

pickup_user

integer

Corretor captador.

Example:

123

pickup_user_expiration

integer

Enviar exclusivamente para o corretor captador (0-6).

Example:

days_for_rule

string[]

Dias de vigência da regra.

from

date

Lead criado em.

Example:

2024-01-01

constructor_id

integer[]

Example:

[1,2,3]

Auth

Bearer

Headers

Body

{ "funnel_step_id": "1", "funnel_step_mix": 2, "name": "carlos%", "interest": null, "origin": 16, "user": [ 123, 456 ], "type": "users", "building": [ 123, 345 ], "building_type": [ 1, 2 ], "detail": [ 123, 321 ], "price_min": "1200.00", "price_max": "1500.00", "state": 1, "city": 2, "limit_security_user": 2, "with_security_user": true, "security_user": [ 12 ], "send_lead_center": true, "district": 3, "active": true, "position": 1, "responsible_respect": true, "responsible_respect_only_rule": false, "hour_respect": true, "online_only": true, "with_contact_only": true, "skip": true, "skip_time": 15, "skip_hour_initial": "08:00", "skip_hour_final": "18:00", "catcher_preference": false, "pickup_user": 123, "pickup_user_expiration": 0, "days_for_rule": null, "from": "2024-01-01", "constructor_id": [ 1, 2, 3 ] }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/deals/rotations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"funnel_step_id\": \"1\",
    \"funnel_step_mix\": 2,
    \"name\": \"carlos%\",
    \"interest\": null,
    \"origin\": 16,
    \"user\": [
        123,
        456
    ],
    \"type\": \"users\",
    \"building\": [
        123,
        345
    ],
    \"building_type\": [
        1,
        2
    ],
    \"detail\": [
        123,
        321
    ],
    \"price_min\": \"1200.00\",
    \"price_max\": \"1500.00\",
    \"state\": 1,
    \"city\": 2,
    \"limit_security_user\": 2,
    \"with_security_user\": true,
    \"security_user\": [
        12
    ],
    \"send_lead_center\": true,
    \"district\": 3,
    \"active\": true,
    \"position\": 1,
    \"responsible_respect\": true,
    \"responsible_respect_only_rule\": false,
    \"hour_respect\": true,
    \"online_only\": true,
    \"with_contact_only\": true,
    \"skip\": true,
    \"skip_time\": 15,
    \"skip_hour_initial\": \"08:00\",
    \"skip_hour_final\": \"18:00\",
    \"catcher_preference\": false,
    \"pickup_user\": 123,
    \"pickup_user_expiration\": 0,
    \"days_for_rule\": null,
    \"from\": \"2024-01-01\",
    \"constructor_id\": [
        1,
        2,
        3
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/deals/rotations';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'funnel_step_id' => '1',
            'funnel_step_mix' => 2,
            'name' => 'carlos%',
            'interest' => null,
            'origin' => 16,
            'user' => [
                123,
                456,
            ],
            'type' => 'users',
            'building' => [
                123,
                345,
            ],
            'building_type' => [
                1,
                2,
            ],
            'detail' => [
                123,
                321,
            ],
            'price_min' => '1200.00',
            'price_max' => '1500.00',
            'state' => 1,
            'city' => 2,
            'limit_security_user' => 2,
            'with_security_user' => true,
            'security_user' => [
                12,
            ],
            'send_lead_center' => true,
            'district' => 3,
            'active' => true,
            'position' => 1,
            'responsible_respect' => true,
            'responsible_respect_only_rule' => false,
            'hour_respect' => true,
            'online_only' => true,
            'with_contact_only' => true,
            'skip' => true,
            'skip_time' => 15,
            'skip_hour_initial' => '08:00',
            'skip_hour_final' => '18:00',
            'catcher_preference' => false,
            'pickup_user' => 123,
            'pickup_user_expiration' => 0,
            'days_for_rule' => null,
            'from' => '2024-01-01',
            'constructor_id' => [
                1,
                2,
                3,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Obter

GET

https://api.apresenta.me/deals/rotations/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da Regra

Example:

Query Parameters

sort

string

Campo para ordenar os registros

Example:

order

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id,name,interest,type

include[funnelStep]

string

Retorna dados da etapa do funil da regra.

Example:

id,title

include[origins]

string

Retorna as origens.

Example:

id,description

include[buildings]

string

Retorna os Imóveis específicos da regra.

Example:

id,title

include[buildingTypes]

string

Retorna os tipos de imóveis da regra.

Example:

id,description

include[constructor_idToJson]

string

Retorna as construtoras.

Example:

id,name

include[details]

string

Retorna os detalhes.

Example:

id,description

include[users]

string

Retorna os usuários.

Example:

id,name,email

include[states]

string

Retorna os estados da regra.

Example:

id,name,abbreviation

include[cities]

string

Retorna as cidades da regra.

Example:

id,name,abbreviation

include[districts]

string

Retorna os bairros da regra.

Example:

id,name

include[pickupUsers]

string

Retorna os corretores captadores.

Example:

id,name

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/deals/rotations/12?sort=order&fields=id%2Cname%2Cinterest%2Ctype&include%5BfunnelStep%5D=id%2Ctitle&include%5Borigins%5D=id%2Cdescription&include%5Bbuildings%5D=id%2Ctitle&include%5BbuildingTypes%5D=id%2Cdescription&include%5Bconstructor_idToJson%5D=id%2Cname&include%5Bdetails%5D=id%2Cdescription&include%5Busers%5D=id%2Cname%2Cemail&include%5Bstates%5D=id%2Cname%2Cabbreviation&include%5Bcities%5D=id%2Cname%2Cabbreviation&include%5Bdistricts%5D=id%2Cname&include%5BpickupUsers%5D=id%2Cname" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/deals/rotations/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da Regra

Example:

Body Parameters

funnel_step_id

integer

ID do Funil e etapa para encaminhar o lead.

Example:

funnel_step_mix

integer

ID do Funil e etapa para encaminhar o lead Mesclado.

Example:

name

string

Nome da regra.

Example:

carlos%

interest

string[]

Interesses do lead.

origin

integer

ID da Origem do Lead: 1

Example:

user

integer[]

ID dos Corretores

Example:

[123,456]

type

string

Tipo de rodízio (roleta).

Example:

users

building

integer[]

Imóveis específicos.

Example:

[123,345]

building_type

integer[]

Tipo de Imóvel.

Example:

[1,2]

detail

integer[]

Detalhes do imóvel.

Example:

[123,321]

price_min

string

Preço mínimo do imóvel.

Example:

1200.00

price_max

Preço

máximo do imóvel.

Example:

1500.00

state

integer

Estado.

Example:

city

integer

Cidade.

Example:

district

integer

Bairro.

Example:

active

boolean

Status.

Example:

position

integer

Ordem da regra.

Example:

limit_security_user

integer

Limite de Segurança.

Example:

with_security_user

boolean

Com Corretor de Segurança.

Example:

security_user

integer[]

Corretor de Segurança.

Example:

[12]

send_lead_center

boolean

Enviar para o Bolsão de Leads.

Example:

responsible_respect

boolean

Se o lead já tiver atendimento ou já possuir um responsável, repassá-lo para o mesmo corretor.

Example:

responsible_respect_only_rule

boolean

Respeitar o atendimento ao mesmo corretor apenas se este estiver na regra.

hour_respect

boolean

Distribuir apenas no horário determinado.

Example:

online_only

boolean

Distribuir apenas para corretores online.

Example:

with_contact_only

boolean

Somente Lead com contato.

Example:

skip

boolean

Pular para próximo corretor do rodízio caso o lead não seja aceito dentro do prazo.

Example:

skip_time

integer

Tempo para pular para o próximo corretor do rodízio.

Example:

skip_hour_initial

time

Horário inicial para rodízio de leads.

Example:

08:00

skip_hour_final

time

Horário final para rodízio de leads.

Example:

18:00

catcher_preference

boolean

Dar preferência ao corretor captador.

pickup_user

integer

Corretor captador.

Example:

123

pickup_user_expiration

integer

Enviar exclusivamente para o corretor captador (0-6).

Example:

days_for_rule

string[]

Dias de vigência da regra.

from

date

Lead criado em.

Example:

2024-01-01

constructor_id

integer[]

Example:

[1,2,3]

Auth

Bearer

Headers

URL Parameters

Body

{ "funnel_step_id": 1, "funnel_step_mix": 2, "name": "carlos%", "interest": null, "origin": 18, "user": [ 123, 456 ], "type": "users", "building": [ 123, 345 ], "building_type": [ 1, 2 ], "detail": [ 123, 321 ], "price_min": "1200.00", "price_max": "1500.00", "state": 1, "city": 2, "district": 3, "active": true, "position": 1, "limit_security_user": 2, "with_security_user": true, "security_user": [ 12 ], "send_lead_center": true, "responsible_respect": true, "responsible_respect_only_rule": false, "hour_respect": true, "online_only": true, "with_contact_only": true, "skip": true, "skip_time": 15, "skip_hour_initial": "08:00", "skip_hour_final": "18:00", "catcher_preference": false, "pickup_user": 123, "pickup_user_expiration": 0, "days_for_rule": null, "from": "2024-01-01", "constructor_id": [ 1, 2, 3 ] }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/deals/rotations/7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"funnel_step_id\": 1,
    \"funnel_step_mix\": 2,
    \"name\": \"carlos%\",
    \"interest\": null,
    \"origin\": 18,
    \"user\": [
        123,
        456
    ],
    \"type\": \"users\",
    \"building\": [
        123,
        345
    ],
    \"building_type\": [
        1,
        2
    ],
    \"detail\": [
        123,
        321
    ],
    \"price_min\": \"1200.00\",
    \"price_max\": \"1500.00\",
    \"state\": 1,
    \"city\": 2,
    \"district\": 3,
    \"active\": true,
    \"position\": 1,
    \"limit_security_user\": 2,
    \"with_security_user\": true,
    \"security_user\": [
        12
    ],
    \"send_lead_center\": true,
    \"responsible_respect\": true,
    \"responsible_respect_only_rule\": false,
    \"hour_respect\": true,
    \"online_only\": true,
    \"with_contact_only\": true,
    \"skip\": true,
    \"skip_time\": 15,
    \"skip_hour_initial\": \"08:00\",
    \"skip_hour_final\": \"18:00\",
    \"catcher_preference\": false,
    \"pickup_user\": 123,
    \"pickup_user_expiration\": 0,
    \"days_for_rule\": null,
    \"from\": \"2024-01-01\",
    \"constructor_id\": [
        1,
        2,
        3
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/deals/rotations/7';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'funnel_step_id' => 1,
            'funnel_step_mix' => 2,
            'name' => 'carlos%',
            'interest' => null,
            'origin' => 18,
            'user' => [
                123,
                456,
            ],
            'type' => 'users',
            'building' => [
                123,
                345,
            ],
            'building_type' => [
                1,
                2,
            ],
            'detail' => [
                123,
                321,
            ],
            'price_min' => '1200.00',
            'price_max' => '1500.00',
            'state' => 1,
            'city' => 2,
            'district' => 3,
            'active' => true,
            'position' => 1,
            'limit_security_user' => 2,
            'with_security_user' => true,
            'security_user' => [
                12,
            ],
            'send_lead_center' => true,
            'responsible_respect' => true,
            'responsible_respect_only_rule' => false,
            'hour_respect' => true,
            'online_only' => true,
            'with_contact_only' => true,
            'skip' => true,
            'skip_time' => 15,
            'skip_hour_initial' => '08:00',
            'skip_hour_final' => '18:00',
            'catcher_preference' => false,
            'pickup_user' => 123,
            'pickup_user_expiration' => 0,
            'days_for_rule' => null,
            'from' => '2024-01-01',
            'constructor_id' => [
                1,
                2,
                3,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Excluir

DELETE

https://api.apresenta.me/deals/rotations/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID da Regra

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/deals/rotations/6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Duplicar

GET

https://api.apresenta.me/deals/rotations/{rotation_id}/duplicate

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

rotation_id

integer

required

ID da Regra

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/deals/rotations/17/duplicate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Tickets

Pesquisar

GET

https://api.apresenta.me/tickets

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id, description

filter[id]

integer

ID do Ticket

Example:

filter[business_id]

integer

ID da empresa

Example:

filter[contract_id]

integer

ID do Contrato

Example:

filter[building_id]

integer

ID do Imóvel

Example:

filter[person_id]

integer

ID da Pessoa

Example:

filter[responsible][]

integer[]

ID do Responsável

Example:

filter[title]

string

Título do Ticket

Example:

Problema com a internet

filter[notes]

string

Observações do Ticket

Example:

Internet está lenta

filter[type]

string

Tipo do Ticket. Valores permitidos:

keychain: Chaveiro
eletric: Elétrica
building: Entrega
inspect: Retorno
financial: Financeiro
hydraulic: Hidráulico
woodwork: Marcenaria
paint: Pintura
roof: Telhado
other: Outros

Example:

eletric

filter[priority]

string

Prioridade do Ticket. Valores permitidos:

low: Baixa
normal: Média
high: Alta
highest: Altíssima

Example:

normal

filter[origin]

string

Origem do Ticket. Valores permitidos:

call: Ligação
presential: Presencial
site: Site
client: Área do Cliente
whatsapp: WhatsApp

Example:

call

filter[status]

string

Status do Ticket. Valores permitidos:

pending: Pendente
review: Em Analise
progress: Em Andamento
await: Aguardando Retorno
concluded: Concluido
reopened: Reaberto
canceled: Cancelado

Example:

pending

filter[date]

string

dateTime Data do Ticket

Example:

2025-04-28 14:12:00

filter[expected_date]

string

dateTime Data de Previsão do Ticket

Example:

2025-06-25 09:30:00

filter[buildingIn][]

integer[]

Filtra os Tickets por Imóveis

Example:

filter[personIn][]

integer[]

Filtra os Tickets por Pessoas

Example:

filter[responsibleIn][]

integer[]

Filtra os Tickets por Responsáveis

Example:

filter[typesIn][]

string[]

Filtra os Tickets por Tipos

filter[statusIn][]

string[]

Filtra os Tickets por Status

filter[priorityIn][]

string[]

Filtra os Tickets por Prioridades

filter[originIn][]

string[]

Filtra os Tickets por Origens

filter[late]

boolean

Filtra apenas Tickets atrasados

Example:

include[business]

string

Incluir dados da Empresa

Example:

id,name

include[contract]

integer

Incluir dados do Contrato

Example:

include[building]

string

Incluir dados do Imóvel

Example:

id,title

include[person]

string

Incluir dados da Pessoa

Example:

id,name

include[responsibles]

string

Incluir dados dos Responsáveis

Example:

id,name

include[files]

string

Incluir arquivos anexados

Example:

id,file_name,url

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/tickets?sort=id&fields=id%2C+description&filter%5Bid%5D=2&filter%5Bbusiness_id%5D=6&filter%5Bcontract_id%5D=23&filter%5Bbuilding_id%5D=12&filter%5Bperson_id%5D=5&filter%5Bresponsible%5D%5B%5D=1&filter%5Btitle%5D=Problema+com+a+internet&filter%5Bnotes%5D=Internet+est%C3%A1+lenta&filter%5Btype%5D=eletric&filter%5Bpriority%5D=normal&filter%5Borigin%5D=call&filter%5Bstatus%5D=pending&filter%5Bdate%5D=2025-04-28+14%3A12%3A00&filter%5Bexpected_date%5D=2025-06-25+09%3A30%3A00&filter%5BbuildingIn%5D%5B%5D=1&filter%5BpersonIn%5D%5B%5D=2&filter%5BresponsibleIn%5D%5B%5D=3&filter%5BtypesIn%5D%5B%5D=&filter%5BstatusIn%5D%5B%5D=&filter%5BpriorityIn%5D%5B%5D=&filter%5BoriginIn%5D%5B%5D=&filter%5Blate%5D=1&include%5Bbusiness%5D=id%2Cname&include%5Bcontract%5D=0&include%5Bbuilding%5D=id%2Ctitle&include%5Bperson%5D=id%2Cname&include%5Bresponsibles%5D=id%2Cname&include%5Bfiles%5D=id%2Cfile_name%2Curl" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/tickets

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

business_id

integer

required

ID da empresa

Example:

person_id

integer

required

ID da Pessoa

Example:

title

string

required

Título do Ticket

Example:

Problema com a internet

type

string

required

Tipo do Ticket.

Example:

maiores

origin

string

required

Origem do Ticket. Valores permitidos:

call: Ligação
presential: Presencial
site: Site
client: Área do Cliente
whatsapp: WhatsApp

Example:

call

contract_id

integer

ID do Contrato

Example:

building_id

integer

ID do Imóvel

Example:

responsible

integer[]

ID do Responsável

Example:

[1,2]

notes

string

Observações do Ticket Example: Internet está lenta Valores permitidos:

keychain: Chaveiro
eletric: Elétrica
building: Entrega
inspect: Retorno
financial: Financeiro
hydraulic: Hidráulico
woodwork: Marcenaria
paint: Pintura
roof: Telhado
other: Outros

Example:

eletric

priority

string

Prioridade do Ticket. Valores permitidos:

low: Baixa
normal: Média
high: Alta
highest: Altíssima

Example:

normal

status

string

Status do Ticket. Valores permitidos:

pending: Pendente
review: Em Analise
progress: Em Andamento
await: Aguardando Retorno
concluded: Concluido
reopened: Reaberto
canceled: Cancelado

Example:

pending

date

dateTime

Data do Ticket

Example:

2025-04-28 14:12:00

expected_date

dateTime

Data de Previsão do Ticket

Example:

2025-06-25 09:30:00

Auth

Bearer

Headers

Body

{ "business_id": 6, "person_id": 5, "title": "Problema com a internet", "type": "maiores", "origin": "call", "contract_id": 23, "building_id": 12, "responsible": [ 1, 2 ], "notes": "eletric", "priority": "normal", "status": "pending", "date": "2025-04-28 14:12:00", "expected_date": "2025-06-25 09:30:00" }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/tickets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"business_id\": 6,
    \"person_id\": 5,
    \"title\": \"Problema com a internet\",
    \"type\": \"maiores\",
    \"origin\": \"call\",
    \"contract_id\": 23,
    \"building_id\": 12,
    \"responsible\": [
        1,
        2
    ],
    \"notes\": \"eletric\",
    \"priority\": \"normal\",
    \"status\": \"pending\",
    \"date\": \"2025-04-28 14:12:00\",
    \"expected_date\": \"2025-06-25 09:30:00\"
}"

Obter

GET

https://api.apresenta.me/tickets/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do ticket

Example:

Query Parameters

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:

id, description

include[business]

string

Incluir dados da Empresa

Example:

id,name

include[contract]

integer

Incluir dados do Contrato

Example:

include[building]

string

Incluir dados do Imóvel

Example:

id,title

include[person]

string

Incluir dados da Pessoa

Example:

id,name

include[responsibles]

string

Incluir dados dos Responsáveis

Example:

id,name

include[files]

string

Incluir arquivos anexados

Example:

id,file_name,url

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/tickets/20?fields=id%2C+description&include%5Bbusiness%5D=id%2Cname&include%5Bcontract%5D=0&include%5Bbuilding%5D=id%2Ctitle&include%5Bperson%5D=id%2Cname&include%5Bresponsibles%5D=id%2Cname&include%5Bfiles%5D=id%2Cfile_name%2Curl" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/tickets/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do ticket

Example:

Body Parameters

business_id

integer

ID da empresa

Example:

person_id

integer

ID da Pessoa

Example:

title

string

Título do Ticket

Example:

Problema com a internet

type

string

Tipo do Ticket.

Example:

est

origin

string

Origem do Ticket. Valores permitidos:

call: Ligação
presential: Presencial
site: Site
client: Área do Cliente
whatsapp: WhatsApp

Example:

call

contract_id

integer

ID do Contrato

Example:

building_id

integer

ID do Imóvel

Example:

responsible

integer[]

ID do Responsável

Example:

[1,2]

notes

string

Observações do Ticket Example: Internet está lenta Valores permitidos:

keychain: Chaveiro
eletric: Elétrica
building: Entrega
inspect: Retorno
financial: Financeiro
hydraulic: Hidráulico
woodwork: Marcenaria
paint: Pintura
roof: Telhado
other: Outros

Example:

eletric

priority

string

Prioridade do Ticket. Valores permitidos:

low: Baixa
normal: Média
high: Alta
highest: Altíssima

Example:

normal

status

string

Status do Ticket. Valores permitidos:

pending: Pendente
review: Em Analise
progress: Em Andamento
await: Aguardando Retorno
concluded: Concluido
reopened: Reaberto
canceled: Cancelado

Example:

pending

date

dateTime

Data do Ticket

Example:

2025-04-28 14:12:00

expected_date

dateTime

Data de Previsão do Ticket

Example:

2025-06-25 09:30:00

Auth

Bearer

Headers

URL Parameters

Body

{ "business_id": 6, "person_id": 5, "title": "Problema com a internet", "type": "est", "origin": "call", "contract_id": 23, "building_id": 12, "responsible": [ 1, 2 ], "notes": "eletric", "priority": "normal", "status": "pending", "date": "2025-04-28 14:12:00", "expected_date": "2025-06-25 09:30:00" }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/tickets/9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"business_id\": 6,
    \"person_id\": 5,
    \"title\": \"Problema com a internet\",
    \"type\": \"est\",
    \"origin\": \"call\",
    \"contract_id\": 23,
    \"building_id\": 12,
    \"responsible\": [
        1,
        2
    ],
    \"notes\": \"eletric\",
    \"priority\": \"normal\",
    \"status\": \"pending\",
    \"date\": \"2025-04-28 14:12:00\",
    \"expected_date\": \"2025-06-25 09:30:00\"
}"

Excluir

DELETE

https://api.apresenta.me/tickets/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

Id do ticket

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/tickets/7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Usuários

Pesquisar

GET

https://api.apresenta.me/users

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros.

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta.

Example:

id,login,name,email

filter[id]

integer

ID do usuário.

Example:

123456

filter[group_id]

integer

ID do grupo ao qual o usuário pertence.

Example:

filter[team_id]

integer

ID da equipe a qual o usuário está associado.

Example:

filter[login]

string

Example:

usuario123

filter[person_id]

integer

ID da pessoa associada ao usuário.

Example:

56789

filter[name]

string

Nome do usuário.

Example:

João Silva

filter[name_public]

string

Nome para o site.

Example:

João Silva

filter[creci]

string

CRECI do usuário (para corretor de imóveis).

Example:

12345-J

filter[description]

string

Descrição do usuário.

Example:

Exemplo descrição...

filter[email]

string

E-mail do usuário.

Example:

email@example.com

filter[phone]

string

Telefone do usuário.

Example:

(11) 98765-4321

filter[active]

boolean

Status do usuário.

Example:

filter[public]

boolean

Mostra no site.

include[calendars]

string

Retorna os dados dos calendários criados pelo usuário.

Example:

id,name

include[principalCalendar]

string

Retorna os dados do calendário do usuário.

Example:

id,name

include[systemCalendar]

string

Retorna os dados do calendário pelo usuário via sistema.

Example:

id,name

include[notifications]

string

Retorna os dados das notificações.

Example:

id,name

include[group]

string

Retorna os dados do grupo ao qual o usuário pertence.

Example:

id,name

include[team]

string

Retorna os dados da equipe a qual o usuário pertence.

Example:

id,name

include[permissionsTable]

string

Retorna as permissões que o usuário possui.

Example:

permission

include[messages]

string

Retorna as mensagens do usuário.

Example:

type,message

include[buildings]

string

Retorna os imóveis em que o usuário é responsável.

Example:

id,title

include[persons]

string

Retorna as pessoas que o usuário é responsável.

Example:

id,name

include[person]

string

Retorna os dados da pessoa vinculada ao usuário.

Example:

id,name

include[tickets]

string

Retorna os tickets em que o usuário é responsável.

Example:

id,name

include[contracts]

string

Retorna os contrato.

Example:

id,name

include[deals]

string

Retorna as negociações que o usuário é responsável.

Example:

id,title,status

include[events]

string

Retorna os eventos que o usuário está como convidado.

Example:

id,title

include[historys]

string

Retorna os históricos gerados pelo usuário.

Example:

description

include[transactions]

string

Retorna as transações do usuário (corretor).

Example:

mode,type,description

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/users?sort=id&fields=id%2Clogin%2Cname%2Cemail&filter%5Bid%5D=123456&filter%5Bgroup_id%5D=3&filter%5Bteam_id%5D=5&filter%5Blogin%5D=usuario123&filter%5Bperson_id%5D=56789&filter%5Bname%5D=Jo%C3%A3o+Silva&filter%5Bname_public%5D=Jo%C3%A3o+Silva&filter%5Bcreci%5D=12345-J&filter%5Bdescription%5D=Exemplo+descri%C3%A7%C3%A3o...&filter%5Bemail%5D=email%40example.com&filter%5Bphone%5D=%2811%29+98765-4321&filter%5Bactive%5D=1&filter%5Bpublic%5D=&include%5Bcalendars%5D=id%2Cname&include%5BprincipalCalendar%5D=id%2Cname&include%5BsystemCalendar%5D=id%2Cname&include%5Bnotifications%5D=id%2Cname&include%5Bgroup%5D=id%2Cname&include%5Bteam%5D=id%2Cname&include%5BpermissionsTable%5D=permission&include%5Bmessages%5D=type%2Cmessage&include%5Bbuildings%5D=id%2Ctitle&include%5Bpersons%5D=id%2Cname&include%5Bperson%5D=id%2Cname&include%5Btickets%5D=id%2Cname&include%5Bcontracts%5D=id%2Cname&include%5Bdeals%5D=id%2Ctitle%2Cstatus&include%5Bevents%5D=id%2Ctitle&include%5Bhistorys%5D=description&include%5Btransactions%5D=mode%2Ctype%2Cdescription" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/users';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'sort' => 'id',
            'fields' => 'id,login,name,email',
            'filter[id]' => '123456',
            'filter[group_id]' => '3',
            'filter[team_id]' => '5',
            'filter[login]' => 'usuario123',
            'filter[person_id]' => '56789',
            'filter[name]' => 'João Silva',
            'filter[name_public]' => 'João Silva',
            'filter[creci]' => '12345-J',
            'filter[description]' => 'Exemplo descrição...',
            'filter[email]' => 'email@example.com',
            'filter[phone]' => '(11) 98765-4321',
            'filter[active]' => '1',
            'filter[public]' => '0',
            'include[calendars]' => 'id,name',
            'include[principalCalendar]' => 'id,name',
            'include[systemCalendar]' => 'id,name',
            'include[notifications]' => 'id,name',
            'include[group]' => 'id,name',
            'include[team]' => 'id,name',
            'include[permissionsTable]' => 'permission',
            'include[messages]' => 'type,message',
            'include[buildings]' => 'id,title',
            'include[persons]' => 'id,name',
            'include[person]' => 'id,name',
            'include[tickets]' => 'id,name',
            'include[contracts]' => 'id,name',
            'include[deals]' => 'id,title,status',
            'include[events]' => 'id,title',
            'include[historys]' => 'description',
            'include[transactions]' => 'mode,type,description',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/users

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

group_id

integer

required

ID do grupo de usuários que o corretor pertence.

Example:

team_id

integer

ID da equipe que o corretor pertence.

Example:

string

required

Example:

eveniet

person_id

integer

ID da pessoa cadastrada no sistema que corresponde ao corretor.

Example:

password

string

required

Senha de acesso ao sistema, devendo ter Carácter especial, letra e número.

Example:

Usuario@8532

name

string

required

Nome do usuário.

Example:

sint

name_public

string

Nome para ser exibido no site.

Example:

possimus

description

string

Descrição para a página do corretor.

Example:

Molestiae dolorem totam dicta ducimus quo.

creci

integer

Número do CRECI.

Example:

5555

string

required

E-mail de contato.

Example:

contato@contato.com

phone

integer

Telefone de contato.

Example:

47988888888

image_path

string

Caminho da foto de perfil.

Example:

url.com

active

boolean

Status do usuário.

Example:

public

boolean

Mostrar o usuário no site.

notes

string

Observações do usuário.

Example:

esse

not_notify

boolean

Não notificar. Example true

position

integer

Ordem de exibição dos corretores no site.

Example:

facebook_id

string

Link do perfil do Facebook.

Example:

culpa

instagram_id

string

Link do perfil do Instagram.

Example:

qui

google_id

integer

ID do google do usuário que cadastrou.

Example:

first_period_in

Hour

Horário de entrada do primeiro período.

Example:

08:00.

first_period_out

Hour

Horário de saída do primeiro período.

Example:

08:00.

second_period_in

Hour

Horário de entrada do segundo período.

Example:

08:00.

second_period_out

Hour

Horário de saída do segundo período.

Example:

08:00.

calender_id

integer

ID do calendário do usuário.

Example:

123

force_password_change

boolean

Forçar troca de senha.

Auth

Bearer

Headers

Body

{ "group_id": 2, "team_id": 5, "login": "eveniet", "person_id": 1, "password": "Usuario@8532", "name": "sint", "name_public": "possimus", "description": "Molestiae dolorem totam dicta ducimus quo.", "creci": 5555, "email": "contato@contato.com", "phone": 47988888888, "image_path": "url.com", "active": true, "public": false, "notes": "esse", "not_notify": false, "position": 13, "facebook_id": "culpa", "instagram_id": "qui", "google_id": 15, "first_period_in": "08:00.", "first_period_out": "08:00.", "second_period_in": "08:00.", "second_period_out": "08:00.", "calender_id": 123, "force_password_change": false }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"group_id\": 2,
    \"team_id\": 5,
    \"login\": \"eveniet\",
    \"person_id\": 1,
    \"password\": \"Usuario@8532\",
    \"name\": \"sint\",
    \"name_public\": \"possimus\",
    \"description\": \"Molestiae dolorem totam dicta ducimus quo.\",
    \"creci\": 5555,
    \"email\": \"contato@contato.com\",
    \"phone\": 47988888888,
    \"image_path\": \"url.com\",
    \"active\": true,
    \"public\": false,
    \"notes\": \"esse\",
    \"not_notify\": false,
    \"position\": 13,
    \"facebook_id\": \"culpa\",
    \"instagram_id\": \"qui\",
    \"google_id\": 15,
    \"first_period_in\": \"08:00.\",
    \"first_period_out\": \"08:00.\",
    \"second_period_in\": \"08:00.\",
    \"second_period_out\": \"08:00.\",
    \"calender_id\": 123,
    \"force_password_change\": false
}"

Obter

GET

https://api.apresenta.me/users/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Usuário

Example:

Query Parameters

sort

string

Campo para ordenar os registros.

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta.

Example:

id,login,name,email

include[calendars]

string

Retorna os dados dos calendários criados pelo usuário.

Example:

id,name

include[principalCalendar]

string

Retorna os dados do calendário do usuário.

Example:

id,name

include[systemCalendar]

string

Retorna os dados do calendário pelo usuário via sistema.

Example:

id,name

include[notifications]

string

Retorna os dados das notificações.

Example:

id,name

include[group]

string

Retorna os dados do grupo ao qual o usuário pertence.

Example:

id,name

include[team]

string

Retorna os dados da equipe a qual o usuário pertence.

Example:

id,name

include[permissionsTable]

string

Retorna as permissões que o usuário possui.

Example:

permission

include[messages]

string

Retorna as mensagens do usuário.

Example:

type,message

include[buildings]

string

Retorna os imóveis em que o usuário é responsável.

Example:

id,title

include[persons]

string

Retorna as pessoas que o usuário é responsável.

Example:

id,name

include[person]

string

Retorna os dados da pessoa vinculada ao usuário.

Example:

id,name

include[tickets]

string

Retorna os tickets em que o usuário é responsável.

Example:

id,name

include[contracts]

string

Retorna os contrato.

Example:

id,name

include[deals]

string

Retorna as negociações que o usuário é responsável.

Example:

id,title,status

include[events]

string

Retorna os eventos que o usuário está como convidado.

Example:

id,title

include[historys]

string

Retorna os históricos gerados pelo usuário.

Example:

description

include[transactions]

string

Retorna as transações do usuário (corretor).

Example:

mode,type,description

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/users/7?sort=id&fields=id%2Clogin%2Cname%2Cemail&include%5Bcalendars%5D=id%2Cname&include%5BprincipalCalendar%5D=id%2Cname&include%5BsystemCalendar%5D=id%2Cname&include%5Bnotifications%5D=id%2Cname&include%5Bgroup%5D=id%2Cname&include%5Bteam%5D=id%2Cname&include%5BpermissionsTable%5D=permission&include%5Bmessages%5D=type%2Cmessage&include%5Bbuildings%5D=id%2Ctitle&include%5Bpersons%5D=id%2Cname&include%5Bperson%5D=id%2Cname&include%5Btickets%5D=id%2Cname&include%5Bcontracts%5D=id%2Cname&include%5Bdeals%5D=id%2Ctitle%2Cstatus&include%5Bevents%5D=id%2Ctitle&include%5Bhistorys%5D=description&include%5Btransactions%5D=mode%2Ctype%2Cdescription" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/users/{id}

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

ID do Usuário

Example:

123

Body Parameters

group_id

integer

ID do grupo de usuários que o corretor pertence.

Example:

team_id

integer

ID da equipe que o corretor pertence.

Example:

string

Example:

dolorem

person_id

integer

ID da pessoa cadastrada no sistema que corresponde ao corretor.

Example:

password

string

Senha de acesso ao sistema, devendo ter Carácter especial, letra e número.

Example:

Usuario@8532

name

string

Nome do usuário.

Example:

consequatur

name_public

string

Nome para ser exibido no site.

Example:

aliquam

description

string

Descrição para a página do corretor.

Example:

Saepe quis pariatur ratione aspernatur veniam harum.

creci

integer

Número do CRECI.

Example:

5555

string

E-mail de contato.

Example:

contato@contato.com

phone

integer

Telefone de contato.

Example:

47988888888

image_path

string

Caminho da foto de perfil.

Example:

url.com

active

boolean

Status do usuário.

Example:

public

boolean

Mostrar o usuário no site.

notes

string

Observações do usuário.

Example:

hic

not_notify

boolean

Não notificar. Example true

Example:

position

integer

Ordem de exibição dos corretores no site.

Example:

facebook_id

string

Link do perfil do Facebook.

Example:

voluptas

instagram_id

string

Link do perfil do Instagram.

Example:

maxime

google_id

integer

ID do google do usuário que cadastrou.

Example:

first_period_in

Hour

Horário de entrada do primeiro período.

Example:

08:00.

first_period_out

Hour

Horário de saída do primeiro período.

Example:

08:00.

second_period_in

Hour

Horário de entrada do segundo período.

Example:

08:00.

second_period_out

Hour

Horário de saída do segundo período.

Example:

08:00.

calender_id

integer

ID do calendário do usuário.

Example:

123

force_password_change

boolean

Forçar troca de senha.

Auth

Bearer

Headers

URL Parameters

Body

{ "group_id": 3, "team_id": 14, "login": "dolorem", "person_id": 1, "password": "Usuario@8532", "name": "consequatur", "name_public": "aliquam", "description": "Saepe quis pariatur ratione aspernatur veniam harum.", "creci": 5555, "email": "contato@contato.com", "phone": 47988888888, "image_path": "url.com", "active": true, "public": false, "notes": "hic", "not_notify": true, "position": 1, "facebook_id": "voluptas", "instagram_id": "maxime", "google_id": 8, "first_period_in": "08:00.", "first_period_out": "08:00.", "second_period_in": "08:00.", "second_period_out": "08:00.", "calender_id": 123, "force_password_change": false }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/users/123" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"group_id\": 3,
    \"team_id\": 14,
    \"login\": \"dolorem\",
    \"person_id\": 1,
    \"password\": \"Usuario@8532\",
    \"name\": \"consequatur\",
    \"name_public\": \"aliquam\",
    \"description\": \"Saepe quis pariatur ratione aspernatur veniam harum.\",
    \"creci\": 5555,
    \"email\": \"contato@contato.com\",
    \"phone\": 47988888888,
    \"image_path\": \"url.com\",
    \"active\": true,
    \"public\": false,
    \"notes\": \"hic\",
    \"not_notify\": true,
    \"position\": 1,
    \"facebook_id\": \"voluptas\",
    \"instagram_id\": \"maxime\",
    \"google_id\": 8,
    \"first_period_in\": \"08:00.\",
    \"first_period_out\": \"08:00.\",
    \"second_period_in\": \"08:00.\",
    \"second_period_out\": \"08:00.\",
    \"calender_id\": 123,
    \"force_password_change\": false
}"

Vistorias

Ambientes

Duplicar

POST

https://api.apresenta.me/inspect/environments/{environment_id}/duplicate

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

environment_id

integer

required

The ID of the environment.

Example:

environment

integer

required

Id do Ambiente

Example:

Body Parameters

description

string

Example:

Banheiro

inspect_id

integer

Example:

icon

string

Example:

ics ic-address-book

condition

string

Example:

good

notes

string[]

withMedia

boolean

Duplica o ambiente e seus itens com as imagens quando ativo

Auth

Bearer

Headers

URL Parameters

Body

{ "description": "Banheiro", "inspect_id": 1, "icon": "ics ic-address-book", "condition": "good", "notes": null, "withMedia": false }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/inspect/environments/7/duplicate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Banheiro\",
    \"inspect_id\": 1,
    \"icon\": \"ics ic-address-book\",
    \"condition\": \"good\",
    \"notes\": null,
    \"withMedia\": false
}"

Pesquisar

GET

https://api.apresenta.me/inspect/environments

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros.

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta.

Example:

id,description,type,condition

filter[id]

integer

Filtra por código do item.

Example:

filter[description]

string

Filtra por descrição do item. Suporta busca parcial.

Example:

%Lampada%

filter[inspect_id]

integer

Filtra por ID da vistoria vinculada.

Example:

123

filter[environment_id]

integer

Filtra por ID do ambiente vinculado.

Example:

456

filter[type]

string

Filtra por tipo de item. Padrão: environment. Valores: item, key, meter, environment.

Example:

environment

filter[condition]

string

Filtra por condição do item. Valores: new, good, regular, used, bad, terrible.

Example:

good

filter[notes]

string

Filtra por observações do item. Suporta busca parcial.

Example:

quebrado

include[inspect]

string

Inclui dados da vistoria vinculada.

Example:

id,reference,date

include[environment]

string

Inclui dados do ambiente vinculado.

Example:

id,name

include[images]

string

Inclui arquivos de imagem relacionados ao item.

Example:

id,name,file_name

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/inspect/environments?sort=id&fields=id%2Cdescription%2Ctype%2Ccondition&filter%5Bid%5D=12&filter%5Bdescription%5D=%25Lampada%25&filter%5Binspect_id%5D=123&filter%5Benvironment_id%5D=456&filter%5Btype%5D=environment&filter%5Bcondition%5D=good&filter%5Bnotes%5D=quebrado&include%5Binspect%5D=id%2Creference%2Cdate&include%5Benvironment%5D=id%2Cname&include%5Bimages%5D=id%2Cname%2Cfile_name" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/inspect/environments

Copiado!

✅

📋

requires authentication

Cria um novo ambiente de vistoria.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

description

string

required

Descrição do ambiente.

Example:

Banheiro

inspect_id

integer

required

ID da vistoria vinculada.

Example:

icon

string

Ícone do ambiente.

Example:

ics ic-address-book

condition

string

Condição do ambiente. Valores: new, good, regular, used, bad, terrible.

Example:

good

notes

string[]

Observações do ambiente (array JSON).

Auth

Bearer

Headers

Body

{ "description": "Banheiro", "inspect_id": 1, "icon": "ics ic-address-book", "condition": "good", "notes": null }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/inspect/environments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Banheiro\",
    \"inspect_id\": 1,
    \"icon\": \"ics ic-address-book\",
    \"condition\": \"good\",
    \"notes\": null
}"

Obter

GET

https://api.apresenta.me/inspect/environments/{id}

Copiado!

✅

📋

requires authentication

Obtém os detalhes de um ambiente de vistoria específico.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the environment.

Example:

assumenda

environment

integer

required

Id do Ambiente.

Example:

Query Parameters

include[inspect]

string

Inclui dados da vistoria vinculada.

Example:

id,reference,date

include[items]

string

Inclui itens do ambiente.

Example:

id,description

include[images]

string

Inclui arquivos de imagem relacionados ao item.

Example:

id,name,file_name

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/inspect/environments/assumenda?include%5Binspect%5D=id%2Creference%2Cdate&include%5Bitems%5D=id%2Cdescription&include%5Bimages%5D=id%2Cname%2Cfile_name" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/inspect/environments/{id}

Copiado!

✅

📋

requires authentication

Altera os dados de um ambiente de vistoria existente.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the environment.

Example:

molestiae

environment

integer

required

Id do Ambiente.

Example:

Body Parameters

description

string

Descrição do ambiente.

Example:

Banheiro

inspect_id

integer

ID da vistoria vinculada.

Example:

icon

string

Ícone do ambiente.

Example:

ics ic-address-book

condition

string

Condição do ambiente. Valores: new, good, regular, used, bad, terrible.

Example:

good

notes

string[]

Observações do ambiente (array JSON).

Auth

Bearer

Headers

URL Parameters

Body

{ "description": "Banheiro", "inspect_id": 1, "icon": "ics ic-address-book", "condition": "good", "notes": null }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/inspect/environments/molestiae" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Banheiro\",
    \"inspect_id\": 1,
    \"icon\": \"ics ic-address-book\",
    \"condition\": \"good\",
    \"notes\": null
}"

Excluir

DELETE

https://api.apresenta.me/inspect/environments/{id}

Copiado!

✅

📋

requires authentication

Exclui um ambiente de vistoria existente.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the environment.

Example:

aliquid

environment

integer

required

Id do Ambiente.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/inspect/environments/aliquid" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Itens

Pesquisar

GET

https://api.apresenta.me/inspect/items

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros.

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta.

Example:

id,description,type,condition

filter[id]

integer

Filtra por código do item.

Example:

filter[description]

string

Filtra por descrição do item. Suporta busca parcial.

Example:

%Lampada%

filter[inspect_id]

integer

Filtra por ID da vistoria vinculada.

Example:

123

filter[environment_id]

integer

Filtra por ID do ambiente vinculado.

Example:

456

filter[type]

string

Filtra por tipo de item. Padrão: item. Valores: item, key, meter, environment.

Example:

item

filter[condition]

string

Filtra por condição do item. Valores: new, good, regular, used, bad, terrible.

Example:

good

filter[notes]

string

Filtra por observações do item. Suporta busca parcial.

Example:

quebrado

include[inspect]

string

Inclui dados da vistoria vinculada.

Example:

id,reference,date

include[environment]

string

Inclui dados do ambiente vinculado.

Example:

id,name

include[images]

string

Inclui arquivos de imagem relacionados ao item.

Example:

id,name,file_name

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/inspect/items?sort=id&fields=id%2Cdescription%2Ctype%2Ccondition&filter%5Bid%5D=12&filter%5Bdescription%5D=%25Lampada%25&filter%5Binspect_id%5D=123&filter%5Benvironment_id%5D=456&filter%5Btype%5D=item&filter%5Bcondition%5D=good&filter%5Bnotes%5D=quebrado&include%5Binspect%5D=id%2Creference%2Cdate&include%5Benvironment%5D=id%2Cname&include%5Bimages%5D=id%2Cname%2Cfile_name" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/inspect/items

Copiado!

✅

📋

requires authentication

Cria um novo item de vistoria.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

description

string

required

Descrição do item.

Example:

Lampada

environment_id

integer

required

ID do ambiente vinculado.

Example:

icon

string

Ícone do item.

Example:

ics ic-address-book

condition

string

Condição do item. Valores: new, good, regular, used, bad, terrible.

Example:

good

notes

string[]

Observações do item (array JSON).

Auth

Bearer

Headers

Body

{ "description": "Lampada", "environment_id": 1, "icon": "ics ic-address-book", "condition": "good", "notes": null }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/inspect/items" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Lampada\",
    \"environment_id\": 1,
    \"icon\": \"ics ic-address-book\",
    \"condition\": \"good\",
    \"notes\": null
}"

Obter

GET

https://api.apresenta.me/inspect/items/{id}

Copiado!

✅

📋

requires authentication

Obtém os detalhes de um item de vistoria específico.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the item.

Example:

ratione

item

integer

required

Id do Item.

Example:

Query Parameters

include[inspect]

string

Inclui dados da vistoria vinculada.

Example:

id,reference,date

include[environment]

string

Inclui dados do ambiente vinculado.

Example:

id,name

include[images]

string

Inclui arquivos de imagem relacionados ao item.

Example:

id,name,file_name

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/inspect/items/ratione?include%5Binspect%5D=id%2Creference%2Cdate&include%5Benvironment%5D=id%2Cname&include%5Bimages%5D=id%2Cname%2Cfile_name" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/inspect/items/{id}

Copiado!

✅

📋

requires authentication

Altera os dados de um item de vistoria existente.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the item.

Example:

illum

item

integer

required

Id do Item.

Example:

Body Parameters

description

string

Descrição do item.

Example:

Lampada

environment_id

integer

ID do ambiente vinculado.

Example:

icon

string

Ícone do item.

Example:

ics ic-address-book

condition

string

Condição do item. Valores: new, good, regular, used, bad, terrible.

Example:

good

notes

string[]

Observações do item (array JSON).

Auth

Bearer

Headers

URL Parameters

Body

{ "description": "Lampada", "environment_id": 1, "icon": "ics ic-address-book", "condition": "good", "notes": null }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/inspect/items/illum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Lampada\",
    \"environment_id\": 1,
    \"icon\": \"ics ic-address-book\",
    \"condition\": \"good\",
    \"notes\": null
}"

Excluir

DELETE

https://api.apresenta.me/inspect/items/{id}

Copiado!

✅

📋

requires authentication

Exclui um item de vistoria existente.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the item.

Example:

odit

item

integer

required

Id do Item.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/inspect/items/odit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Pesquisar

GET

https://api.apresenta.me/inspects

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

sort

string

Campo para ordenar os registros.

Example:

fields

string

Lista de campos separados por vírgula sem espaço para incluir na resposta.

Example:

id,type,status,date

filter[id]

integer

Filtra por código da vistoria.

Example:

filter[reference]

string

Filtra por referência única da vistoria.

Example:

VIS-2024-01

filter[type]

string

Filtra por tipo da vistoria. Valores possíveis: entrance, exit, capture, maintenance.

Example:

entrance

filter[status]

string

Filtra por status da vistoria. Valores: pending, requested, progress, signature, canceled, finished.

Example:

pending

filter[contract_id]

integer

Filtra por ID do contrato vinculado.

Example:

123

filter[building_id]

integer

Filtra por ID do imóvel vinculado.

Example:

456

filter[user_id]

integer

Filtra por responsável pela vistoria.

Example:

filter[business_id]

integer

Filtra por ID da empresa vinculada.

Example:

filter[date]

string

Filtra por data da vistoria (YYYY-MM-DD).

Example:

2025-05-01

filter[area]

number

Filtra por metragem da vistoria.

Example:

120.5

filter[furniture]

string

Filtra por mobília. Valores possíveis: furnished, semi_furnished, unfurnished.

Example:

furnished

filter[tag]

integer

Filtra por ID da tag vinculada.

Example:

filter[notes]

string

Filtra por observações gerais (busca no array JSON). Suporta busca parcial.

Example:

pintura

filter[father_id]

integer

Filtra por ID da vistoria principal (quando esta for uma reedição).

Example:

filter[withImageCount]

boolean

Inclui a contagem de imagens da vistoria via scope.

Example:

include[building]

string

Inclui dados do imóvel vinculado.

Example:

id,reference,title

include[contract]

integer

Inclui dados do contrato vinculado.

Example:

include[user]

string

Inclui dados do usuário responsável.

Example:

id,name,email

include[tags]

string

Inclui as tags vinculadas.

Example:

id,description

include[business]

string

Inclui dados da empresa responsável.

Example:

id,name

include[environments]

string

Inclui ambientes da vistoria.

Example:

id,name

include[keys]

string

Inclui os itens do tipo chave.

Example:

id,name

include[meters]

string

Inclui os itens do tipo medidor.

Example:

id,name

include[files]

string

Inclui arquivos relacionados à vistoria.

Example:

id,name,file_name

include[father]

string

Inclui os dados da vistoria pai (original).

Example:

id,type,date

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/inspects?sort=id&fields=id%2Ctype%2Cstatus%2Cdate&filter%5Bid%5D=12&filter%5Breference%5D=VIS-2024-01&filter%5Btype%5D=entrance&filter%5Bstatus%5D=pending&filter%5Bcontract_id%5D=123&filter%5Bbuilding_id%5D=456&filter%5Buser_id%5D=3&filter%5Bbusiness_id%5D=1&filter%5Bdate%5D=2025-05-01&filter%5Barea%5D=120.5&filter%5Bfurniture%5D=furnished&filter%5Btag%5D=7&filter%5Bnotes%5D=pintura&filter%5Bfather_id%5D=10&filter%5BwithImageCount%5D=1&include%5Bbuilding%5D=id%2Creference%2Ctitle&include%5Bcontract%5D=0&include%5Buser%5D=id%2Cname%2Cemail&include%5Btags%5D=id%2Cdescription&include%5Bbusiness%5D=id%2Cname&include%5Benvironments%5D=id%2Cname&include%5Bkeys%5D=id%2Cname&include%5Bmeters%5D=id%2Cname&include%5Bfiles%5D=id%2Cname%2Cfile_name&include%5Bfather%5D=id%2Ctype%2Cdate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Criar

POST

https://api.apresenta.me/inspects

Copiado!

✅

📋

requires authentication

Cria uma nova vistoria.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

reference

string

required

Referência única da vistoria.

Example:

VIS-2024-01

type

string

required

Tipo da vistoria. Valores possíveis: entrance, exit, capture, maintenance.

Example:

entrance

status

string

required

Status da vistoria. Valores: pending, requested, progress, signature, canceled, finished.

Example:

pending

contract_id

integer

ID do contrato vinculado.

Example:

123

building_id

integer

ID do imóvel vinculado.

Example:

456

user_id

integer

Responsável pela vistoria.

Example:

business_id

integer

ID da empresa vinculada.

Example:

date

string

Data da vistoria (YYYY-MM-DD).

Example:

2025-05-01

area

number

Metragem da vistoria.

Example:

120.5

furniture

string

Mobília. Valores possíveis: furnished, semi_furnished, unfurnished.

Example:

furnished

tag

integer

ID da tag vinculada.

Example:

notes

string[]

Observações gerais (array JSON).

Example:

["Obs. 1","Obs. 2"]

father_id

integer

ID da vistoria principal (quando esta for uma reedição).

Example:

environments

string[]

Ambientes da vistoria.

Example:

["et"]

keys

string[]

Itens do tipo chave.

Example:

[{"description":"Chave da porta da frente"}]

meters

string[]

Itens do tipo medidor.

Example:

[{"description":"Medidor de \u00e1gua"}]

files

string[]

Arquivos relacionados à vistoria.

Example:

["autem"]

Auth

Bearer

Headers

Body

{ "reference": "VIS-2024-01", "type": "entrance", "status": "pending", "contract_id": 123, "building_id": 456, "user_id": 3, "business_id": 1, "date": "2025-05-01", "area": 120.5, "furniture": "furnished", "tag": 7, "notes": [ "Obs. 1", "Obs. 2" ], "father_id": 10, "environments": [ "et" ], "keys": [ { "description": "Chave da porta da frente" } ], "meters": [ { "description": "Medidor de \u00e1gua" } ], "files": [ "autem" ] }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/inspects" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reference\": \"VIS-2024-01\",
    \"type\": \"entrance\",
    \"status\": \"pending\",
    \"contract_id\": 123,
    \"building_id\": 456,
    \"user_id\": 3,
    \"business_id\": 1,
    \"date\": \"2025-05-01\",
    \"area\": 120.5,
    \"furniture\": \"furnished\",
    \"tag\": 7,
    \"notes\": [
        \"Obs. 1\",
        \"Obs. 2\"
    ],
    \"father_id\": 10,
    \"environments\": [
        \"et\"
    ],
    \"keys\": [
        {
            \"description\": \"Chave da porta da frente\"
        }
    ],
    \"meters\": [
        {
            \"description\": \"Medidor de água\"
        }
    ],
    \"files\": [
        \"autem\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/inspects';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => \Symfony\Component\VarExporter\Internal\Hydrator::hydrate(
            $o = [
                clone (($p = &\Symfony\Component\VarExporter\Internal\Registry::$prototypes)['stdClass'] ?? \Symfony\Component\VarExporter\Internal\Registry::p('stdClass')),
                clone $p['stdClass'],
            ],
            null,
            [
                'stdClass' => [
                    'description' => [
                        'Chave da porta da frente',
                        'Medidor de água',
                    ],
                ],
            ],
            [
                'reference' => 'VIS-2024-01',
                'type' => 'entrance',
                'status' => 'pending',
                'contract_id' => 123,
                'building_id' => 456,
                'user_id' => 3,
                'business_id' => 1,
                'date' => '2025-05-01',
                'area' => 120.5,
                'furniture' => 'furnished',
                'tag' => 7,
                'notes' => [
                    'Obs. 1',
                    'Obs. 2',
                ],
                'father_id' => 10,
                'environments' => [
                    'et',
                ],
                'keys' => [
                    $o[0],
                ],
                'meters' => [
                    $o[1],
                ],
                'files' => [
                    'autem',
                ],
            ],
            []
        ),
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Obter

GET

https://api.apresenta.me/inspects/{id}

Copiado!

✅

📋

requires authentication

Obtém os detalhes de uma vistoria específica.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the inspect.

Example:

consequatur

inspect

integer

required

Id da Vistoria.

Example:

Query Parameters

include[building]

string

Inclui dados do imóvel vinculado.

Example:

id,reference,title

include[contract]

integer

Inclui dados do contrato vinculado.

Example:

include[user]

string

Inclui dados do usuário responsável.

Example:

id,name,email

include[tags]

string

Inclui as tags vinculadas.

Example:

id,description

include[business]

string

Inclui dados da empresa responsável.

Example:

id,name

include[environments]

string

Inclui ambientes da vistoria.

Example:

id,name

include[keys]

string

Inclui os itens do tipo chave.

Example:

id,name

include[meters]

string

Inclui os itens do tipo medidor.

Example:

id,name

include[files]

string

Inclui arquivos relacionados à vistoria.

Example:

id,name,file_name

include[father]

string

Inclui os dados da vistoria pai (original).

Example:

id,type,date

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.apresenta.me/inspects/consequatur?include%5Bbuilding%5D=id%2Creference%2Ctitle&include%5Bcontract%5D=0&include%5Buser%5D=id%2Cname%2Cemail&include%5Btags%5D=id%2Cdescription&include%5Bbusiness%5D=id%2Cname&include%5Benvironments%5D=id%2Cname&include%5Bkeys%5D=id%2Cname&include%5Bmeters%5D=id%2Cname&include%5Bfiles%5D=id%2Cname%2Cfile_name&include%5Bfather%5D=id%2Ctype%2Cdate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "return": false,
    "message": "Este recurso não foi encontrado.",
    "status": 404,
    "errors": []
}

Alterar

PUT

PATCH

https://api.apresenta.me/inspects/{id}

Copiado!

✅

📋

requires authentication

Altera os dados de uma vistoria existente.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the inspect.

Example:

inspect

integer

required

Id da Vistoria.

Example:

Body Parameters

reference

string

Referência única da vistoria.

Example:

VIS-2024-01

type

string

Tipo da vistoria. Valores possíveis: entrance, exit, capture, maintenance.

Example:

entrance

status

string

Status da vistoria. Valores: pending, requested, progress, signature, canceled, finished.

Example:

pending

contract_id

integer

ID do contrato vinculado.

Example:

123

building_id

integer

ID do imóvel vinculado.

Example:

456

user_id

integer

Responsável pela vistoria.

Example:

business_id

integer

ID da empresa vinculada.

Example:

date

string

Data da vistoria (YYYY-MM-DD).

Example:

2025-05-01

area

number

Metragem da vistoria.

Example:

120.5

furniture

string

Mobília. Valores possíveis: furnished, semi_furnished, unfurnished.

Example:

furnished

tag

integer

ID da tag vinculada.

Example:

notes

string[]

Observações gerais (array JSON).

Example:

["Obs. 1","Obs. 2"]

father_id

integer

ID da vistoria principal (quando esta for uma reedição).

Example:

environments

string[]

Ambientes da vistoria.

Example:

["sint"]

keys

string[]

Itens do tipo chave.

Example:

[{"description":"Chave da porta da frente"}]

meters

string[]

Itens do tipo medidor.

Example:

[{"description":"Medidor de \u00e1gua"}]

files

string[]

Arquivos relacionados à vistoria.

Example:

["consequuntur"]

Auth

Bearer

Headers

URL Parameters

Body

{ "reference": "VIS-2024-01", "type": "entrance", "status": "pending", "contract_id": 123, "building_id": 456, "user_id": 3, "business_id": 1, "date": "2025-05-01", "area": 120.5, "furniture": "furnished", "tag": 7, "notes": [ "Obs. 1", "Obs. 2" ], "father_id": 10, "environments": [ "sint" ], "keys": [ { "description": "Chave da porta da frente" } ], "meters": [ { "description": "Medidor de \u00e1gua" } ], "files": [ "consequuntur" ] }

Received response

Example request:

curl --request PUT \
    "https://api.apresenta.me/inspects/ex" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reference\": \"VIS-2024-01\",
    \"type\": \"entrance\",
    \"status\": \"pending\",
    \"contract_id\": 123,
    \"building_id\": 456,
    \"user_id\": 3,
    \"business_id\": 1,
    \"date\": \"2025-05-01\",
    \"area\": 120.5,
    \"furniture\": \"furnished\",
    \"tag\": 7,
    \"notes\": [
        \"Obs. 1\",
        \"Obs. 2\"
    ],
    \"father_id\": 10,
    \"environments\": [
        \"sint\"
    ],
    \"keys\": [
        {
            \"description\": \"Chave da porta da frente\"
        }
    ],
    \"meters\": [
        {
            \"description\": \"Medidor de água\"
        }
    ],
    \"files\": [
        \"consequuntur\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.apresenta.me/inspects/ex';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => \Symfony\Component\VarExporter\Internal\Hydrator::hydrate(
            $o = [
                clone (($p = &\Symfony\Component\VarExporter\Internal\Registry::$prototypes)['stdClass'] ?? \Symfony\Component\VarExporter\Internal\Registry::p('stdClass')),
                clone $p['stdClass'],
            ],
            null,
            [
                'stdClass' => [
                    'description' => [
                        'Chave da porta da frente',
                        'Medidor de água',
                    ],
                ],
            ],
            [
                'reference' => 'VIS-2024-01',
                'type' => 'entrance',
                'status' => 'pending',
                'contract_id' => 123,
                'building_id' => 456,
                'user_id' => 3,
                'business_id' => 1,
                'date' => '2025-05-01',
                'area' => 120.5,
                'furniture' => 'furnished',
                'tag' => 7,
                'notes' => [
                    'Obs. 1',
                    'Obs. 2',
                ],
                'father_id' => 10,
                'environments' => [
                    'sint',
                ],
                'keys' => [
                    $o[0],
                ],
                'meters' => [
                    $o[1],
                ],
                'files' => [
                    'consequuntur',
                ],
            ],
            []
        ),
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Excluir

DELETE

https://api.apresenta.me/inspects/{id}

Copiado!

✅

📋

requires authentication

Exclui uma vistoria existente.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the inspect.

Example:

consequatur

inspect

integer

required

Id da Vistoria.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.apresenta.me/inspects/consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Duplicar

POST

https://api.apresenta.me/inspect/{inspect_id}/duplicate

Copiado!

✅

📋

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inspect_id

integer

required

The ID of the inspect.

Example:

inspect

integer

required

ID da Vistoria

Example:

Body Parameters

environments

boolean

Define se duplica os ambientes e seus itens da vistoria

keys

boolean

Define se duplica as chaves da vistoria

meters

boolean

Define se duplica os medidores da vistoria

Example:

persons

boolean

Define se duplica as pessoas da vistoria

medias

boolean

Define se duplica as fotos da vistoria

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "environments": false, "keys": false, "meters": true, "persons": false, "medias": true }

Received response

Example request:

curl --request POST \
    "https://api.apresenta.me/inspect/16/duplicate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"environments\": false,
    \"keys\": false,
    \"meters\": true,
    \"persons\": false,
    \"medias\": true
}"