Skip to content

Owners

Get list of owners

GET/Owners

Get a list of owners managable by the current user.

Scope

read:owneraccounts

Response

200 OK
[
  {
    "id": "1",
    "name": "Home",
    "active": true
  },
  {
    "id": "2",
    "name": "Office",
    "active": true
  }
]

Put owner

PUT/Owners

Create a new Owner Account.

Scope

write:owneraccounts

Body

{
  "name": "Holiday Home"
}

Response

200 OK
{
  "id": "3",
  "name": "Holiday Home",
  "active": true
}

Get owner by ID

GET/Owners/{ownerAccountId}

Get the specified owner.

Scope

read:owneraccounts

Parameters

Name Type Location Description
ownerAccountId string path The owner account to retrieve.

Response

200 OK
{
  "id": "1",
  "name": "Office",
  "active": true
}

Patch owner

PATCH/Owners/{ownerAccountId}

Patch the details of an Owner Account.

The following properties can be patched:

  • name

Scope

write:owneraccounts

Parameters

Name Type Location Description
ownerAccountId string path The owner account to patch.

Body

{
  "name": "Another Home"
}

Response

200 OK
{
  "id": "1",
  "name": "Another Home",
  "active": true
}