Skip to main content

Get all PartnerEntities

GET 
/partner/entities

Retrieves all PartnerEntities associated with the authenticated partner, each with the origins that belong to it.

Use this endpoint to look up externalEntityId​

This is where you get the externalEntityId values you need elsewhere. In particular, scoping a webhook subscription to a single project requires that id — see Register a real-estate webhook subscription, whose externalEntityId field expects exactly the value returned here.

Some of your entities may have ids you did not choose

Every PartnerEntity has an externalEntityId. The create endpoint of this API requires you to supply one, but entities created without one — for example from the banca.me partner dashboard — carry a derived value of the form ext-id-<default origin label>.

So do not assume every id is one you supplied. This listing is the only place to read them, and it is what you should reconcile against before scoping a subscription — guessing an id you think you assigned may not match what exists.

origins is unique to this endpoint​

The create and update endpoints return the entity without the origins array. Only this listing includes it.

Request​

Responses​

List of PartnerEntities retrieved successfully