Skip to main content
Provident Estate API home page
Search...
⌘K
Search...
Navigation
Provident Estate API
API Reference
health
GET
Health check endpoint
OAuth
POST
OAuth2 Token Endpoint
oauth2-clients
GET
List all OAuth clients
POST
Create a new OAuth client
GET
Get an OAuth client by Client ID
PUT
Update an OAuth client by Client ID
DEL
Deactivate an OAuth client by Client ID (sets isActive=false)
POST
Rotate client secret by Client ID
oauth2-tokens
POST
Introspect a token
POST
Revoke a token
portal
GET
Get user data from Telegram DB and ELK via PortalService
GET
Trigger a historical sync of user activity from ELK to Bitrix.
GET
Search PF locations data
GET
Search PF locations data for Telegram
GET
Get location ID from name by exact match.
POST
Update leads data
POST
Enrich leads data
POST
Queue a lead for both update and enrichment.
POST
Generate a PDF
POST
Generate a PDF with new design (2 pages per listing)
Bitrix
GET
Trigger acquisition of Bitrix deals (primary and secondary). Returns immediately while work continues in background.
POST
Trigger acquisition of Bitrix locations data (cities, communities, subcommunities, properties) and create hierarchical table. Returns immediately while work continues in background.
POST
Synchronize locations between Property Finder and Bitrix CRM. Updates PF locations, refreshes CRM data, and adds missing locations to CRM with proper hierarchy.
POST
Test endpoint for PF location synchronization. Accepts PF location JSON and attempts to add it to CRM.
GET
Get deals summary grouped by ASSIGNED_BY_ID from local database
GET
Get deals summary for a specific ASSIGNED_BY_ID from local database
GET
Get matched user from Bitrix24
GET
Get lead from Bitrix24
POST
Create a lead from a landing page
GET
Get product from Bitrix24
GET
Get CRM item from Bitrix24
POST
Create a new CRM item in Bitrix24
GET
Get lead product rows from Bitrix24
POST
Create a new lead in Bitrix24
POST
Terminate a user in GenieMap based on Bitrix ID or Email
POST
Terminate a user in Jumpcloud based on Bitrix ID or Email
POST
Terminate a user in Telegram DB based on Bitrix ID or Email
JumpCloud
GET
List all system users
GET
List all user groups
GET
List the parent Groups of a User
GET
List Scheduled Userstate Change Jobs
POST
Create Scheduled Userstate Job
POST
Search for system users
GenieMap
GET
Get all emirates
GET
Get emirate by ID
GET
Get districts
GET
Get district by ID
GET
Get projects
GET
Get project by ID
GET
Get developers
GET
Get developer by ID
GET
Get amenities
GET
Get unit types
GET
Get finishes
GET
Get unit layouts
GET
Get project units
GET
Get users
POST
Create user
PUT
Update user
DEL
Delete user
POST
Upload image
Property Finder
POST
Update locations for Property Finder
portal/v1/bitly
GET
Retrieve all stored projects with their details and Bitly links
POST
Create a project link using query parameters.
POST
Create a project link using JSON payload.
POST
Create a campaign link using query parameters
POST
Create a campaign link using JSON payload
Dynamics
GET
Get all employees
POST
Create new employee
GET
Get employee by No
DEL
Delete employee
PATCH
Update employee
POST
Update all employees from external sources like JumpCloud and Bitrix
DEL
Deletes all employees from dynamics and resyncs the local database
Eventbrite
GET
Authenticate with Eventbrite API
POST
Fetch event orders and process them as leads
Etisalat
POST
Check DNCR (Do Not Call Registry) status for phone numbers
GET
Send SMS via Etisalat SMS service with dynamic link generation (GET method)
POST
Send SMS via Etisalat SMS service with dynamic link generation (POST method)
GET
Get SMS balance from Etisalat SMS service
portal/shortlink/project
GET
Retrieve all stored projects with their details and short links
POST
Create a project link using query parameters.
POST
Create a project link using JSON payload.
portal/shortlink/campaign
GET
Retrieve all stored campaigns with their details and short links
POST
Create a campaign link using query parameters
POST
Create a campaign link using JSON payload
portal/shortlink/redirect
GET
Get click analytics for a campaign
On this page
Get Started
Provident Estate API
Welcome to the Provident Estate API documentation. Your guide to integrating with our services.
Get Started
Explore our API, read our guides, or jump right into the action with our quickstart.
API Reference
Explore all the available API endpoints and models.
⌘I