Référence de l’API¶
Généré à partir du schéma OpenAPI de cette version de HouseCairn. Les descriptions des opérations et des champs viennent du code et sont en anglais.
POST /api/v1/account/delete/
Operation: account_delete_create
Erase the account of the signed-in person, for good. The address (and the password, for an account that has one) confirm it. Refused while the account is the only owner of a home with other members, or the only administrator.
Request body |
Schema |
|---|---|
application/json |
AccountDeletionRequest |
Response |
Description |
Schema |
|---|---|---|
204 |
No response body |
GET /api/v1/homes/
Operation: homes_list
Homes of the authenticated user (narrowed to the token’s homes, if any). The list includes homes locked behind a sign-in provider (`locked`); reading or changing one answers 403 with `code: sso_required` until the session signs in through it.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
cursor |
query |
no |
string |
The pagination cursor value. |
page_size |
query |
no |
integer |
Number of results to return per page. |
Response |
Description |
Schema |
|---|---|---|
200 |
PaginatedHomeList |
POST /api/v1/homes/
Operation: homes_create
Homes of the authenticated user (narrowed to the token’s homes, if any). The list includes homes locked behind a sign-in provider (`locked`); reading or changing one answers 403 with `code: sso_required` until the session signs in through it.
Request body |
Schema |
|---|---|
application/json |
HomeRequest |
Response |
Description |
Schema |
|---|---|---|
201 |
Home |
GET /api/v1/homes/{home_id}/
Operation: homes_retrieve
Homes of the authenticated user (narrowed to the token’s homes, if any). The list includes homes locked behind a sign-in provider (`locked`); reading or changing one answers 403 with `code: sso_required` until the session signs in through it.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string (uuid) |
A UUID string identifying this home. |
Response |
Description |
Schema |
|---|---|---|
200 |
Home |
PATCH /api/v1/homes/{home_id}/
Operation: homes_partial_update
Homes of the authenticated user (narrowed to the token’s homes, if any). The list includes homes locked behind a sign-in provider (`locked`); reading or changing one answers 403 with `code: sso_required` until the session signs in through it.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string (uuid) |
A UUID string identifying this home. |
Request body |
Schema |
|---|---|
application/json |
PatchedHomeRequest |
Response |
Description |
Schema |
|---|---|---|
200 |
Home |
GET /api/v1/homes/{home_id}/audit/
Operation: homes_audit_list
Audit log of the home: roles, invitations, sign-in rule, export. Owners only.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
cursor |
query |
no |
string |
The pagination cursor value. |
home_id |
path |
yes |
string (uuid) |
A UUID string identifying this home. |
page_size |
query |
no |
integer |
Number of results to return per page. |
Response |
Description |
Schema |
|---|---|---|
200 |
PaginatedAuditEventList |
POST /api/v1/homes/{home_id}/delete/
Operation: homes_delete_create
Delete the home for good. The confirmation is the exact name of the home.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string (uuid) |
A UUID string identifying this home. |
Request body |
Schema |
|---|---|
application/json |
HomeDeletionRequest |
Response |
Description |
Schema |
|---|---|---|
204 |
No response body |
POST /api/v1/homes/{home_id}/events/
Operation: homes_events_create
For web and API views alike: `get_homes()`, and `get_home()` from the URL. A home the user cannot see answers 404, never 403, so its existence does not leak. A home of the user that requires a sign-in provider this session did not use raises `SsoRequiredError` (403, with the provider to use).
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string (uuid) |
Request body |
Schema |
|---|---|
application/json |
EventRequest |
Response |
Description |
Schema |
|---|---|---|
202 |
Event |
POST /api/v1/homes/{home_id}/export/
Operation: homes_export_create
Everything of the home as one archive: `export.json` (versioned, documented in Administration > Export and deletion) and the home’s files. Owners only, signed in: an API token cannot export.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string (uuid) |
A UUID string identifying this home. |
Response |
Description |
Schema |
|---|---|---|
200 |
string (binary) |
GET /api/v1/homes/{home_id}/invitations/
Operation: homes_invitations_list
Pending invitations of a home; owners only.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
cursor |
query |
no |
string |
The pagination cursor value. |
home_id |
path |
yes |
string |
|
page_size |
query |
no |
integer |
Number of results to return per page. |
Response |
Description |
Schema |
|---|---|---|
200 |
PaginatedInvitationList |
POST /api/v1/homes/{home_id}/invitations/
Operation: homes_invitations_create
Pending invitations of a home; owners only.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
Request body |
Schema |
|---|---|
application/json |
InvitationRequest |
Response |
Description |
Schema |
|---|---|---|
201 |
Invitation |
DELETE /api/v1/homes/{home_id}/invitations/{invitation_id}/
Operation: homes_invitations_destroy
Revoke the invitation: its link stops working.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
invitation_id |
path |
yes |
string (uuid) |
A UUID string identifying this invitation. |
Response |
Description |
Schema |
|---|---|---|
204 |
No response body |
POST /api/v1/homes/{home_id}/invitations/{invitation_id}/resend/
Operation: homes_invitations_resend_create
A new link and a new expiry; the previous link stops working.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
invitation_id |
path |
yes |
string (uuid) |
A UUID string identifying this invitation. |
Response |
Description |
Schema |
|---|---|---|
200 |
Invitation |
GET /api/v1/homes/{home_id}/items/
Operation: homes_items_list
Items (equipment or surfaces) of a home. Patching `room` moves an item.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
cursor |
query |
no |
string |
The pagination cursor value. |
home_id |
path |
yes |
string |
|
page_size |
query |
no |
integer |
Number of results to return per page. |
q |
query |
no |
string |
Only names containing this text. |
room |
query |
no |
string (uuid) |
Only items of this room. |
Response |
Description |
Schema |
|---|---|---|
200 |
PaginatedItemList |
POST /api/v1/homes/{home_id}/items/
Operation: homes_items_create
Items (equipment or surfaces) of a home. Patching `room` moves an item.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
Request body |
Schema |
|---|---|
application/json |
ItemRequest |
Response |
Description |
Schema |
|---|---|---|
201 |
Item |
GET /api/v1/homes/{home_id}/items/{item_id}/
Operation: homes_items_retrieve
Items (equipment or surfaces) of a home. Patching `room` moves an item.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
item_id |
path |
yes |
string (uuid) |
A UUID string identifying this item. |
Response |
Description |
Schema |
|---|---|---|
200 |
Item |
DELETE /api/v1/homes/{home_id}/items/{item_id}/
Operation: homes_items_destroy
Items (equipment or surfaces) of a home. Patching `room` moves an item.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
item_id |
path |
yes |
string (uuid) |
A UUID string identifying this item. |
Response |
Description |
Schema |
|---|---|---|
204 |
No response body |
PATCH /api/v1/homes/{home_id}/items/{item_id}/
Operation: homes_items_partial_update
Items (equipment or surfaces) of a home. Patching `room` moves an item.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
item_id |
path |
yes |
string (uuid) |
A UUID string identifying this item. |
Request body |
Schema |
|---|---|
application/json |
PatchedItemRequest |
Response |
Description |
Schema |
|---|---|---|
200 |
Item |
POST /api/v1/homes/{home_id}/leave/
Operation: homes_leave_create
Leave the home. The last owner cannot leave.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string (uuid) |
A UUID string identifying this home. |
Response |
Description |
Schema |
|---|---|---|
204 |
No response body |
GET /api/v1/homes/{home_id}/members/
Operation: homes_members_list
Members of a home. Owners change roles, remove members and hand over ownership.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
cursor |
query |
no |
string |
The pagination cursor value. |
home_id |
path |
yes |
string |
|
page_size |
query |
no |
integer |
Number of results to return per page. |
Response |
Description |
Schema |
|---|---|---|
200 |
PaginatedMembershipList |
GET /api/v1/homes/{home_id}/members/{member_id}/
Operation: homes_members_retrieve
Members of a home. Owners change roles, remove members and hand over ownership.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
member_id |
path |
yes |
string (uuid) |
A UUID string identifying this membership. |
Response |
Description |
Schema |
|---|---|---|
200 |
Membership |
DELETE /api/v1/homes/{home_id}/members/{member_id}/
Operation: homes_members_destroy
Members of a home. Owners change roles, remove members and hand over ownership.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
member_id |
path |
yes |
string (uuid) |
A UUID string identifying this membership. |
Response |
Description |
Schema |
|---|---|---|
204 |
No response body |
PATCH /api/v1/homes/{home_id}/members/{member_id}/
Operation: homes_members_partial_update
Members of a home. Owners change roles, remove members and hand over ownership.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
member_id |
path |
yes |
string (uuid) |
A UUID string identifying this membership. |
Request body |
Schema |
|---|---|
application/json |
PatchedRoleChangeRequest |
Response |
Description |
Schema |
|---|---|---|
200 |
Membership |
POST /api/v1/homes/{home_id}/members/{member_id}/make-owner/
Operation: homes_members_make_owner_create
Make this member owner; the acting owner becomes a member.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
member_id |
path |
yes |
string (uuid) |
A UUID string identifying this membership. |
Response |
Description |
Schema |
|---|---|---|
200 |
Membership |
GET /api/v1/homes/{home_id}/photos/
Operation: homes_photos_list
Photos of rooms and items. Upload as `multipart/form-data`; the image is checked by its content, written again without its metadata (location included) and limited in size.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
category |
query |
no |
string |
|
cursor |
query |
no |
string |
The pagination cursor value. |
home_id |
path |
yes |
string |
|
item |
query |
no |
string (uuid) |
Only photos of this item. |
page_size |
query |
no |
integer |
Number of results to return per page. |
room |
query |
no |
string (uuid) |
Only photos of this room. |
Response |
Description |
Schema |
|---|---|---|
200 |
PaginatedPhotoList |
POST /api/v1/homes/{home_id}/photos/
Operation: homes_photos_create
Photos of rooms and items. Upload as `multipart/form-data`; the image is checked by its content, written again without its metadata (location included) and limited in size.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
Request body |
Schema |
|---|---|
multipart/form-data |
PhotoUploadRequest |
Response |
Description |
Schema |
|---|---|---|
201 |
Photo |
GET /api/v1/homes/{home_id}/photos/{photo_id}/
Operation: homes_photos_retrieve
Photos of rooms and items. Upload as `multipart/form-data`; the image is checked by its content, written again without its metadata (location included) and limited in size.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
photo_id |
path |
yes |
string (uuid) |
A UUID string identifying this photo. |
Response |
Description |
Schema |
|---|---|---|
200 |
Photo |
DELETE /api/v1/homes/{home_id}/photos/{photo_id}/
Operation: homes_photos_destroy
Photos of rooms and items. Upload as `multipart/form-data`; the image is checked by its content, written again without its metadata (location included) and limited in size.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
photo_id |
path |
yes |
string (uuid) |
A UUID string identifying this photo. |
Response |
Description |
Schema |
|---|---|---|
204 |
No response body |
PATCH /api/v1/homes/{home_id}/photos/{photo_id}/
Operation: homes_photos_partial_update
Photos of rooms and items. Upload as `multipart/form-data`; the image is checked by its content, written again without its metadata (location included) and limited in size.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
photo_id |
path |
yes |
string (uuid) |
A UUID string identifying this photo. |
Request body |
Schema |
|---|---|
application/json |
PatchedPhotoRequest |
multipart/form-data |
PatchedPhotoRequest |
application/x-www-form-urlencoded |
PatchedPhotoRequest |
Response |
Description |
Schema |
|---|---|---|
200 |
Photo |
GET /api/v1/homes/{home_id}/photos/{photo_id}/content/
Operation: homes_photos_content_retrieve
The image, as stored: JPEG, PNG or WebP, served inline and never sniffed.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
photo_id |
path |
yes |
string (uuid) |
A UUID string identifying this photo. |
Response |
Description |
Schema |
|---|---|---|
200 |
string (binary) |
GET /api/v1/homes/{home_id}/photos/{photo_id}/thumbnail/
Operation: homes_photos_thumbnail_retrieve
A JPEG thumbnail of the photo.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
photo_id |
path |
yes |
string (uuid) |
A UUID string identifying this photo. |
Response |
Description |
Schema |
|---|---|---|
200 |
string (binary) |
GET /api/v1/homes/{home_id}/rooms/
Operation: homes_rooms_list
Rooms of a home, with their memory (paint, coverings, notes). Listed in their order; `POST …/rooms/reorder/` changes it. Deleting a room deletes its items and photos (they can be restored by the instance owner, not through the API).
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
cursor |
query |
no |
string |
The pagination cursor value. |
home_id |
path |
yes |
string |
|
page_size |
query |
no |
integer |
Number of results to return per page. |
q |
query |
no |
string |
Only names containing this text. |
Response |
Description |
Schema |
|---|---|---|
200 |
PaginatedRoomList |
POST /api/v1/homes/{home_id}/rooms/
Operation: homes_rooms_create
Rooms of a home, with their memory (paint, coverings, notes). Listed in their order; `POST …/rooms/reorder/` changes it. Deleting a room deletes its items and photos (they can be restored by the instance owner, not through the API).
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
Request body |
Schema |
|---|---|
application/json |
RoomRequest |
Response |
Description |
Schema |
|---|---|---|
201 |
Room |
GET /api/v1/homes/{home_id}/rooms/{room_id}/
Operation: homes_rooms_retrieve
Rooms of a home, with their memory (paint, coverings, notes). Listed in their order; `POST …/rooms/reorder/` changes it. Deleting a room deletes its items and photos (they can be restored by the instance owner, not through the API).
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
room_id |
path |
yes |
string (uuid) |
A UUID string identifying this room. |
Response |
Description |
Schema |
|---|---|---|
200 |
Room |
DELETE /api/v1/homes/{home_id}/rooms/{room_id}/
Operation: homes_rooms_destroy
Rooms of a home, with their memory (paint, coverings, notes). Listed in their order; `POST …/rooms/reorder/` changes it. Deleting a room deletes its items and photos (they can be restored by the instance owner, not through the API).
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
room_id |
path |
yes |
string (uuid) |
A UUID string identifying this room. |
Response |
Description |
Schema |
|---|---|---|
204 |
No response body |
PATCH /api/v1/homes/{home_id}/rooms/{room_id}/
Operation: homes_rooms_partial_update
Rooms of a home, with their memory (paint, coverings, notes). Listed in their order; `POST …/rooms/reorder/` changes it. Deleting a room deletes its items and photos (they can be restored by the instance owner, not through the API).
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string |
|
room_id |
path |
yes |
string (uuid) |
A UUID string identifying this room. |
Request body |
Schema |
|---|---|
application/json |
PatchedRoomRequest |
Response |
Description |
Schema |
|---|---|---|
200 |
Room |
POST /api/v1/homes/{home_id}/rooms/reorder/
Operation: homes_rooms_reorder_create
Put the listed rooms first, in that order; the others keep their order after them.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
cursor |
query |
no |
string |
The pagination cursor value. |
home_id |
path |
yes |
string |
|
page_size |
query |
no |
integer |
Number of results to return per page. |
Request body |
Schema |
|---|---|
application/json |
RoomOrderRequest |
Response |
Description |
Schema |
|---|---|---|
200 |
PaginatedRoomList |
GET /api/v1/homes/{home_id}/search/
Operation: homes_search_retrieve
Rooms and items of a home whose name contains `q`, up to 50 of each.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string (uuid) |
|
q |
query |
yes |
string |
Response |
Description |
Schema |
|---|---|---|
200 |
SearchResults |
POST /api/v1/homes/{home_id}/unlock/
Operation: homes_unlock_create
Stop requiring a sign-in provider the instance no longer offers (owners).
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
home_id |
path |
yes |
string (uuid) |
A UUID string identifying this home. |
Response |
Description |
Schema |
|---|---|---|
200 |
Home |
GET /api/v1/instance/audit/
Operation: instance_audit_list
Audit log of the instance: administration, invitations, accounts. No home content.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
cursor |
query |
no |
string |
The pagination cursor value. |
page_size |
query |
no |
integer |
Number of results to return per page. |
Response |
Description |
Schema |
|---|---|---|
200 |
PaginatedAuditEventList |
GET /api/v1/instance/invitations/
Operation: instance_invitations_list
Pending invitations to the instance. They are sent by email, never returned.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
cursor |
query |
no |
string |
The pagination cursor value. |
page_size |
query |
no |
integer |
Number of results to return per page. |
Response |
Description |
Schema |
|---|---|---|
200 |
PaginatedInstanceInvitationList |
POST /api/v1/instance/invitations/
Operation: instance_invitations_create
Pending invitations to the instance. They are sent by email, never returned.
Request body |
Schema |
|---|---|
application/json |
InstanceInvitationRequest |
Response |
Description |
Schema |
|---|---|---|
201 |
InstanceInvitation |
DELETE /api/v1/instance/invitations/{invitation_id}/
Operation: instance_invitations_destroy
Revoke the invitation: its link stops working.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
invitation_id |
path |
yes |
string (uuid) |
A UUID string identifying this instance invitation. |
Response |
Description |
Schema |
|---|---|---|
204 |
No response body |
POST /api/v1/instance/invitations/{invitation_id}/resend/
Operation: instance_invitations_resend_create
A new link and a new expiry; the previous link stops working.
Parameter |
In |
Required |
Type |
Description |
|---|---|---|---|---|
invitation_id |
path |
yes |
string (uuid) |
A UUID string identifying this instance invitation. |
Response |
Description |
Schema |
|---|---|---|
200 |
InstanceInvitation |
POST /api/v1/instance/unlock/
Operation: instance_unlock_create
Clear the sign-in rule of every home whose provider the instance no longer offers.
Response |
Description |
Schema |
|---|---|---|
200 |
Unlocked |
POST /api/v1/invitations/accept/
Operation: invitations_accept_create
Accept an invitation with the secret of its link, for the signed-in account. The account’s address must be the invited one. Unknown, used, revoked and expired secrets all answer 404.
Request body |
Schema |
|---|---|
application/json |
InvitationAcceptRequest |
Response |
Description |
Schema |
|---|---|---|
200 |
Home |
Schemas
AccountDeletionRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
confirm_email |
string (email) |
yes |
no |
password |
string |
no |
no |
AuditEvent
Field |
Type |
Required |
Read-only |
|---|---|---|---|
id |
string (uuid) |
yes |
yes |
created_at |
string (date-time) |
yes |
yes |
scope |
ScopeEnum |
yes |
yes |
action |
string |
yes |
yes |
label |
string |
yes |
yes |
actor_email |
string (email) |
yes |
yes |
target_email |
string (email) |
yes |
yes |
detail |
object |
yes |
yes |
CategoryEnum
Values: general, open_walls
Event
Field |
Type |
Required |
Read-only |
|---|---|---|---|
id |
string (uuid) |
yes |
yes |
kind |
string |
yes |
no |
payload |
object |
no |
no |
created_at |
string (date-time) |
yes |
yes |
EventRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
kind |
string |
yes |
no |
payload |
object |
no |
no |
Home
Field |
Type |
Required |
Read-only |
|---|---|---|---|
id |
string (uuid) |
yes |
yes |
name |
string |
yes |
no |
currency |
string |
no |
no |
role |
RoleEnum | NullEnum |
yes |
yes |
required_provider |
string |
no |
no |
locked |
boolean |
yes |
yes |
created_at |
string (date-time) |
yes |
yes |
updated_at |
string (date-time) |
yes |
yes |
HomeDeletionRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
confirmation |
string |
yes |
no |
HomeRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
name |
string |
yes |
no |
currency |
string |
no |
no |
required_provider |
string |
no |
no |
InstanceInvitation
Field |
Type |
Required |
Read-only |
|---|---|---|---|
id |
string (uuid) |
yes |
yes |
string (email) |
yes |
no |
|
sent_at |
string (date-time) |
yes |
yes |
expires_at |
string (date-time) |
yes |
yes |
InstanceInvitationRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
string (email) |
yes |
no |
Invitation
Field |
Type |
Required |
Read-only |
|---|---|---|---|
id |
string (uuid) |
yes |
yes |
string (email) |
yes |
no |
|
role |
RoleEnum |
no |
no |
sent_at |
string (date-time) |
yes |
yes |
expires_at |
string (date-time) |
yes |
yes |
link |
string | null |
yes |
yes |
InvitationAcceptRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
token |
string |
yes |
no |
InvitationRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
string (email) |
yes |
no |
|
role |
RoleEnum |
no |
no |
Item
Field |
Type |
Required |
Read-only |
|---|---|---|---|
id |
string (uuid) |
yes |
yes |
room |
string (uuid) |
yes |
no |
name |
string |
yes |
no |
kind |
ItemKindEnum |
no |
no |
brand |
string |
no |
no |
model |
string |
no |
no |
serial_number |
string |
no |
no |
installed_on |
string | null (date) |
no |
no |
warranty_ends_on |
string | null (date) |
no |
no |
contract |
string |
no |
no |
contract_url |
string (uri) | string |
no |
no |
links |
array of Link |
no |
no |
notes |
string |
no |
no |
created_at |
string (date-time) |
yes |
yes |
updated_at |
string (date-time) |
yes |
yes |
ItemKindEnum
Values: equipment, surface
ItemRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
room |
string (uuid) |
yes |
no |
name |
string |
yes |
no |
kind |
ItemKindEnum |
no |
no |
brand |
string |
no |
no |
model |
string |
no |
no |
serial_number |
string |
no |
no |
installed_on |
string | null (date) |
no |
no |
warranty_ends_on |
string | null (date) |
no |
no |
contract |
string |
no |
no |
contract_url |
string (uri) | string |
no |
no |
links |
array of LinkRequest |
no |
no |
notes |
string |
no |
no |
Link
Field |
Type |
Required |
Read-only |
|---|---|---|---|
url |
string (uri) |
yes |
no |
label |
string |
no |
no |
LinkRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
url |
string (uri) |
yes |
no |
label |
string |
no |
no |
MemberUser
Field |
Type |
Required |
Read-only |
|---|---|---|---|
id |
string (uuid) |
yes |
yes |
string (email) |
yes |
yes |
|
name |
string |
yes |
yes |
Membership
Field |
Type |
Required |
Read-only |
|---|---|---|---|
id |
string (uuid) |
yes |
yes |
user |
MemberUser |
yes |
yes |
role |
RoleEnum |
no |
no |
created_at |
string (date-time) |
yes |
yes |
updated_at |
string (date-time) |
yes |
yes |
NullEnum
PaginatedAuditEventList
Field |
Type |
Required |
Read-only |
|---|---|---|---|
next |
string (uri) |
no |
no |
previous |
string (uri) |
no |
no |
results |
array of AuditEvent |
yes |
no |
PaginatedHomeList
Field |
Type |
Required |
Read-only |
|---|---|---|---|
next |
string (uri) |
no |
no |
previous |
string (uri) |
no |
no |
results |
array of Home |
yes |
no |
PaginatedInstanceInvitationList
Field |
Type |
Required |
Read-only |
|---|---|---|---|
next |
string (uri) |
no |
no |
previous |
string (uri) |
no |
no |
results |
array of InstanceInvitation |
yes |
no |
PaginatedInvitationList
Field |
Type |
Required |
Read-only |
|---|---|---|---|
next |
string (uri) |
no |
no |
previous |
string (uri) |
no |
no |
results |
array of Invitation |
yes |
no |
PaginatedItemList
Field |
Type |
Required |
Read-only |
|---|---|---|---|
next |
string (uri) |
no |
no |
previous |
string (uri) |
no |
no |
results |
array of Item |
yes |
no |
PaginatedMembershipList
Field |
Type |
Required |
Read-only |
|---|---|---|---|
next |
string (uri) |
no |
no |
previous |
string (uri) |
no |
no |
results |
array of Membership |
yes |
no |
PaginatedPhotoList
Field |
Type |
Required |
Read-only |
|---|---|---|---|
next |
string (uri) |
no |
no |
previous |
string (uri) |
no |
no |
results |
array of Photo |
yes |
no |
PaginatedRoomList
Field |
Type |
Required |
Read-only |
|---|---|---|---|
next |
string (uri) |
no |
no |
previous |
string (uri) |
no |
no |
results |
array of Room |
yes |
no |
PatchedHomeRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
name |
string |
no |
no |
currency |
string |
no |
no |
required_provider |
string |
no |
no |
PatchedItemRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
room |
string (uuid) |
no |
no |
name |
string |
no |
no |
kind |
ItemKindEnum |
no |
no |
brand |
string |
no |
no |
model |
string |
no |
no |
serial_number |
string |
no |
no |
installed_on |
string | null (date) |
no |
no |
warranty_ends_on |
string | null (date) |
no |
no |
contract |
string |
no |
no |
contract_url |
string (uri) | string |
no |
no |
links |
array of LinkRequest |
no |
no |
notes |
string |
no |
no |
PatchedPhotoRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
category |
CategoryEnum |
no |
no |
caption |
string |
no |
no |
PatchedRoleChangeRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
role |
RoleEnum |
no |
no |
PatchedRoomRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
name |
string |
no |
no |
kind |
RoomKindEnum |
no |
no |
notes |
string |
no |
no |
paint_colour |
string |
no |
no |
paint_brand |
string |
no |
no |
paint_reference |
string |
no |
no |
paint_batch |
string |
no |
no |
paint_stock |
string |
no |
no |
floor_covering |
string |
no |
no |
wall_covering |
string |
no |
no |
memory_notes |
string |
no |
no |
Photo
Field |
Type |
Required |
Read-only |
|---|---|---|---|
id |
string (uuid) |
yes |
yes |
room |
string | null (uuid) |
yes |
yes |
item |
string | null (uuid) |
yes |
yes |
category |
CategoryEnum |
no |
no |
caption |
string |
no |
no |
content_type |
string |
yes |
yes |
size_bytes |
integer |
yes |
yes |
width |
integer |
yes |
yes |
height |
integer |
yes |
yes |
content_url |
string (uri) |
yes |
yes |
thumbnail_url |
string (uri) |
yes |
yes |
created_at |
string (date-time) |
yes |
yes |
updated_at |
string (date-time) |
yes |
yes |
PhotoUploadRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
file |
string (binary) |
yes |
no |
room |
string (uuid) |
no |
no |
item |
string (uuid) |
no |
no |
caption |
string |
no |
no |
category |
CategoryEnum |
no |
no |
RoleEnum
Values: owner, member, read_only
Room
Field |
Type |
Required |
Read-only |
|---|---|---|---|
id |
string (uuid) |
yes |
yes |
name |
string |
yes |
no |
kind |
RoomKindEnum |
no |
no |
position |
integer |
yes |
yes |
notes |
string |
no |
no |
paint_colour |
string |
no |
no |
paint_brand |
string |
no |
no |
paint_reference |
string |
no |
no |
paint_batch |
string |
no |
no |
paint_stock |
string |
no |
no |
floor_covering |
string |
no |
no |
wall_covering |
string |
no |
no |
memory_notes |
string |
no |
no |
item_count |
integer |
yes |
yes |
created_at |
string (date-time) |
yes |
yes |
updated_at |
string (date-time) |
yes |
yes |
RoomKindEnum
Values: living, kitchen, bathroom, bedroom, hallway, office, utility, garage, cellar, attic, outdoor, other
RoomOrderRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
order |
array of string (uuid) |
yes |
no |
RoomRequest
Field |
Type |
Required |
Read-only |
|---|---|---|---|
name |
string |
yes |
no |
kind |
RoomKindEnum |
no |
no |
notes |
string |
no |
no |
paint_colour |
string |
no |
no |
paint_brand |
string |
no |
no |
paint_reference |
string |
no |
no |
paint_batch |
string |
no |
no |
paint_stock |
string |
no |
no |
floor_covering |
string |
no |
no |
wall_covering |
string |
no |
no |
memory_notes |
string |
no |
no |
ScopeEnum
Values: home, instance
SearchResults
Field |
Type |
Required |
Read-only |
|---|---|---|---|
rooms |
array of Room |
yes |
no |
items |
array of Item |
yes |
no |
Unlocked
Field |
Type |
Required |
Read-only |
|---|---|---|---|
unlocked |
integer |
yes |
no |