This endpoint can be used to fetch all organizations to which you are related based on the provided access token, either as a member that has been invited (e.g. agency employees) or as the owner of the organization.
GET /organizations
[
{
"id": "string",
"phone_number": "string",
"email_address": "string",
"organization_name": "string",
"country": "string",
"region": "string",
"street": "string",
"house_number": "string",
"house_number_extra": "string",
"zipcode": "string",
"place": "string"
}
]
200 OK
This endpoint can be used to edit the basic information of your organization. Only organization owners can adjust this information.
PATCH /organizations/{organization_id}
{
"phone_number": "string",
"email_address": "string",
"organization_name": "string",
"country": "string",
"street": "string",
"house_number": "string",
"house_number_extra": "string",
"zipcode": "string",
"place": "string"
}
{
"id": "string",
"phone_number": "string",
"email_address": "string",
"organization_name": "string",
"country": "string",
"region": "string",
"street": "string",
"house_number": "string",
"house_number_extra": "string",
"zipcode": "string",
"place": "string"
}
200 OK
This endpoint returns a list of all members that have been added to the organization. Members include both employees (e.g. broker accounts) and clients (e.g. potential buyers of a real estate agency).
GET /organizations/{organization_id}/members
[
{
"id": "string",
"email_address": "string",
"first_name": "string",
"last_name": "string",
"member_type": "string"
}
]
200 OK
Members, such as organization employees or potential buyers, can be added by inviting them to your organization. This endpoint creates new members and attaches them to the organization. New members will also get notified by email, in order to guide them through the process of activating their accounts.
POST /organizations/{organization_id}/members
{
"email_address": "string",
"first_name": "string",
"last_name": "string",
"member_type": "string"
}
{
"id": "string",
"email_address": "string",
"first_name": "string",
"last_name": "string",
"member_type": "string"
}
201 Created
This endpoint can be used to remove members from the organization. Important: when members are deleted using this endpoint, all connections to specific estates will also be deleted.
DELETE /organizations/{organization_id}/members/{member_id}
200 OK