BETA

Your client's users on the portal

GET /property-v1/customers/{portal}/users

When you publish a listing you can choose which agent is responsible for it, by sending their email address in branch.agentEmail. But that address must belong to a user that exists in the portal account — and this endpoint is where you get it.

If you send an address that belongs to no user, the portal does not return an error. It replaces it with the account administrator's and the publication returns 200. That is why it is worth reading the user list beforehand, instead of finding out by looking at the listing.

Two levels, and the default one costs nothing

CallWhat you getCost
GET .../usersAll users, with their email address and rolenothing
GET .../users?detail=trueThe same, plus names and phone numbers1 call from your client's quota

The basic level is not a cut-down version of the other one: it brings more people. The detail only exists for users with an agent role, so the administrator appears in the free level only — and that is precisely the one the portal uses when it does not recognise the address you sent.

How to request it

curl https://property-api.mapaprop.com/property-v1/customers/zonapropapi/users \
  -H "Authorization: Bearer <YOUR_TOKEN>" \
  -H "x-client-ref: cliente-42"

200 response:

{
  "portal": "zonapropapi",
  "portalAccountId": "11451",
  "users": [
    { "email": "director@inmobiliaria.com", "role": "admin", "portalRole": "Administrador",
      "firstName": null, "lastName": null, "phone": null, "mobile": null },
    { "email": "carina@inmobiliaria.com", "role": "agent", "portalRole": "Vendedor",
      "firstName": null, "lastName": null, "phone": null, "mobile": null }
  ],
  "detail": false,
  "portalCalls": 0,
  "readAt": "2026-11-16T21:40:12.004Z"
}
FieldWhat it is
emailThe user's email address. It is what you send in branch.agentEmail when publishing
roleThe normalised role: admin, superuser, assistant, agent. null if the portal uses one we do not know yet
portalRoleThe same role exactly as the portal names it. It is the one you will see in their panel
firstName, lastName, phone, mobileOnly with detail=true. In the free level they are null because we did not read them, not because the user does not have them
detailWhether the detail could actually be read
portalCallsHow many calls from your client's quota this request cost

With the detail

curl "https://property-api.mapaprop.com/property-v1/customers/zonapropapi/users?detail=true" \
  -H "Authorization: Bearer <YOUR_TOKEN>" \
  -H "x-client-ref: cliente-42"
{
  "users": [
    { "email": "carina@inmobiliaria.com", "role": "agent", "portalRole": "Vendedor",
      "firstName": "Carina", "lastName": "Milesse", "phone": "3425050115", "mobile": null }
  ],
  "detail": true,
  "portalCalls": 1
}

This is useful for building the listing's full contact details: if you choose an agent, it is best to send their name and phone number in branch as well, because the portal does not derive them from the email address.

If the detail cannot be read, the response does not fail: it returns the user list all the same, with detail: false. Losing the extra data is better than losing the list.

Users are created on the portal, not here

This API does not create, edit or remove users. Adding a collaborator, their permissions and their WhatsApp number are managed from the portal's panel, by the client themselves.

If your client adds an agent to their CRM but does not add them on the portal, their email address will not work as agentEmail: the portal does not recognise it and assigns the listing to the administrator.

When it returns an error

CodeWhat happened
409 portal_not_connectedThe client does not have an active connection with that portal
501 portal_sin_padron_de_usuariosThat portal does not expose a user list. It is not your mistake — we do not know how to ask that portal yet
502 portal_unreachableThe portal did not respond. Try again

The user list is currently available on Zonaprop (zonapropapi).