Users
Users Overview
Syncing agent profiles between CRM and Rentix
Through the API, you sync agent profiles from your CRM so clients see up-to-date contact information.
Listings can be published without linking to an agent — in this case, agency information is displayed. This is convenient during transition while not all agents are registered.
How It Works
Your CRM Rentix
┌─────────────┐ ┌─────────────┐
│ Agent #42 │ PUT /users │ User │
│ externalId: ├────────────────────────►│ id: 15 │
│ "agent-42" │ (name, contacts, │ externalId: │
│ │ description) │ "agent-42" │
└─────────────┘ └─────────────┘
When creating a listing, specify userId — and it will be linked to that agent.
Limitation
Creating new users via API is not available. Agents must be invited through the web interface to verify their phone number.
How to Invite an Agent
- Log in to rentix.md
- Open Menu → Agency Name → Invitations
- Enter the agent's email and send the invitation
- After registration, the agent appears in the list and can be synced via API
What You Can Do via API
| Task | Method | Endpoint |
|---|---|---|
| Update profile | PUT | /users |
| Update multiple agents | POST | /users/bulk |
| Get agent list | GET | /users |
| Find by ID | GET | /users/:id |
| Find by external ID | GET | /users/external/:externalId |
| Link external ID | POST | /users/:id/link |
| Unlink external ID | DELETE | /users/:id/link |
Profile Structure
{
"id": 15,
"externalId": "agent-42",
"name": "Ivan Petrov",
"phone": "+373 22 123 456",
"description": "Experienced residential real estate agent...",
"avatar": {
"id": 123,
"variants": [
{ "url": "https://storage.../128.webp", "variantSize": "128" }
]
},
"instagram": "https://instagram.com/ivan.petrov",
"youtube": null,
"tiktok": null,
"settings": {
"posting_type": "agent",
"contact_phone": true,
"contact_whatsapp": true,
"contact_viber": false,
"contact_telegram": true
}
}
| Field | Description |
|---|---|
id | Internal Rentix ID |
externalId | Your agent ID from CRM |
name | Name displayed on listings |
phone | Phone from registration (read-only) |
description | Agent profile description |
avatar | Profile photo with optimized variants |
instagram, youtube, tiktok | Social media links |
settings | Contact display settings |
Typical Scenario
1. Get agent list → GET /users
→ find agents without externalId
2. Link external ID → POST /users/:id/link
→ connect with CRM record
3. Sync profile → PUT /users
→ pass name, description, contacts
4. Link to listings → PUT /listings
→ pass userId when creating
Next Steps
- Update agent profile — data synchronization
- Get agent list — search and external ID linking