API Documentation
Agent ¶
Overview
An Agent is a represantation of a Real Estate Agent
Get Agent ¶
Get AgentGET/agents/{id}
Example URI
GET /agents/f1bf0265-25d2-4a2a-9c1e-89881f7edef1
URI Parameters
- id
string(required) Example: f1bf0265-25d2-4a2a-9c1e-89881f7edef1
Response
200Body
{
"code": "OK",
"data": {
"id": "f1bf0265-25d2-4a2a-9c1e-89881f7edef1",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760469935.601759,
"deleted_at": null,
"created_at": 1760469935.601759,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
}Search for an agent ¶
Search for an agentGET/agents/search?mlsid=
Example URI
GET /agents/search?mlsid=
URI Parameters
- q
string(required) Example: Gholi
Response
200Body
{
"code": "OK",
"data": [
{
"id": "f1bf0265-25d2-4a2a-9c1e-89881f7edef1",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760469935.601759,
"deleted_at": null,
"created_at": 1760469935.601759,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"info": {
"count": 1,
"total": 0
}
}Get all agents of an office ¶
Get all agents of an officeGET/agents/search?officemlsid=
Example URI
GET /agents/search?officemlsid=
URI Parameters
- officemlsid
string(required) Example: RCHT01X- mls
string(required) Example: NTREIS
Response
200Body
{
"code": "OK",
"data": [
{
"id": "f1bf0265-25d2-4a2a-9c1e-89881f7edef1",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760469935.601759,
"deleted_at": null,
"created_at": 1760469935.601759,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"info": {
"count": 1,
"total": 0
}
}