1. Portais
Veploy API
  • Visão geral
  • Autenticação
  • Limites de requisição
  • Imóveis
    • Listar imóveis
    • Consultar imóvel
    • Cadastrar imóvel
    • Alterar imóvel
    • Excluir imóvel
    • Restaurar imóvel
    • Enviar foto do imóvel (Beta)
    • Remover foto do imóvel (Beta)
    • Listar tipos de imóvel
  • Proprietários
    • Listar proprietários
    • Consultar proprietário
    • Cadastrar proprietário
    • Alterar proprietário
    • Excluir proprietário
  • Leads
    • Listar leads
    • Consultar lead
    • Criar lead
    • Alterar responsável
    • Atualizar lead
    • Consultar linha do tempo do lead
  • Visitas
    • Listar visitas
    • Consultar visita
    • Agendar visita
    • Alterar visita
  • Propostas
    • Listar propostas
    • Consultar proposta
    • Registrar proposta
    • Alterar proposta
  • Portais
    • Listar portais
      GET
    • Consultar portal
      GET
    • Listar imóveis do XML
      GET
  • Usuários
    • Listar usuários
    • Consultar usuário
    • Consultar permissões do usuário
    • Convidar usuário
    • Alterar ficha do usuário
    • Desativar usuário
    • Reativar usuário
    • Remover usuário
  • Perfis de acesso
    • Listar perfis de acesso
  • Artigos
    • Listar artigos
    • Criar artigo
    • Consultar artigo
    • Alterar artigo
    • Enviar capa do artigo (Beta)
  • Temas
    • Tema do site
  1. Portais

Consultar portal

GET
/v1/portals/{portal}
Retorna um portal pelo id, com as cotas e as regras de seleção configuradas na conta.

Requisição

Authorization
Bearer Token
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
or
Parâmetros de Caminho

Respostas

🟢200
application/json
Default Response
Bodyapplication/json

🟠400
🟠401
🟠403
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.veploy.com/v1/portals/' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Exemplo 1
{
    "data": {
        "slug": "string",
        "name": "string",
        "status": "active",
        "xml_url": null,
        "lead_url": null,
        "address_visibility": "all",
        "rules": [
            {
                "name": "string",
                "enabled": true,
                "ad_type": "string",
                "conditions": [
                    {
                        "field": "string",
                        "operator": "string",
                        "values": [
                            "string"
                        ]
                    }
                ]
            }
        ],
        "default_ad_type": "string",
        "ad_types": [
            {
                "slug": "string",
                "name": "string",
                "quota": 0,
                "auto_fill": true,
                "include_rules": [
                    {
                        "field": "string",
                        "operator": "string",
                        "values": [
                            "string"
                        ]
                    }
                ],
                "exclude_rules": [
                    {
                        "field": "string",
                        "operator": "string",
                        "values": [
                            "string"
                        ]
                    }
                ]
            }
        ],
        "last_export": {
            "state": "ready",
            "at": "2019-08-24T14:15:22.123Z",
            "properties_count": 0
        }
    }
}
Modificado em 2026-11-04 18:08:49
Página anterior
Listar portais
Próxima página
Listar imóveis do XML
Built with