Owners¶

Get List of Owners¶

GET/api/v1/Owners

Get a list of owners manageable by the current user.

read:owneraccounts

200 OK

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

PUT/api/v1/Owners

Create a new owner account.

write:owneraccounts

{
  "name": "Holiday Home"
}

200 OK

Info

This operation is not available in the context of a Client Credentials request.

GET/api/v1/Owners/{ownerAccountId}

Get the specified owner.

read:owneraccounts

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

200 OK

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

PATCH/api/v1/Owners/{ownerAccountId}

Patch the details of an Owner Account.

The following properties can be patched:

write:owneraccounts

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

{
  "name": "Another Home"
}

200 OK

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