API docs by Redocly

ClutterStock API (v1)

Download OpenAPI specification:

Because "somewhere in the garage" isn't a location. Home inventory for your actual clutter—electronics, parts, homelab and all.

Version: main

Items

Creates a new item.

Creates a new item.

Authorizations:
oidc
Request Body schema: application/json
required
roomId
integer <int32> [ 1 .. 2147483647 ]

Id of the room this item belongs to.

name
required
string [ 1 .. 200 ] characters

Display name of the item.

description
string or null [ 0 .. 2000 ] characters

Optional longer description.

category
string or null [ 0 .. 100 ] characters

Optional category (e.g. Electronics, Furniture).

notes
string or null [ 0 .. 2000 ] characters

Optional free-form notes.

Responses

Request samples

Content type
application/json
{
  • "roomId": 1,
  • "name": "Vintage Lamp",
  • "description": "Brass table lamp, 1980s",
  • "category": "Electronics",
  • "notes": "Needs new shade"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "roomId": 1,
  • "name": "Vintage Lamp",
  • "description": "Brass table lamp, 1980s",
  • "category": "Electronics",
  • "notes": "Needs new shade",
  • "createdAtUtc": "2024-01-15T10:30:00Z",
  • "updatedAtUtc": "2024-02-01T14:00:00Z"
}

Returns all items.

Returns all items.

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes an item by id.

Deletes an item by id.

Authorizations:
oidc
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

Returns a single item by id.

Returns a single item by id.

Authorizations:
oidc
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "roomId": 1,
  • "name": "Vintage Lamp",
  • "description": "Brass table lamp, 1980s",
  • "category": "Electronics",
  • "notes": "Needs new shade",
  • "createdAtUtc": "2024-01-15T10:30:00Z",
  • "updatedAtUtc": "2024-02-01T14:00:00Z"
}

Updates an existing item by id.

Updates an existing item by id.

Authorizations:
oidc
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]
Request Body schema: application/json
required
roomId
integer <int32> [ 1 .. 2147483647 ]

Id of the room this item belongs to.

name
required
string [ 1 .. 200 ] characters

Display name of the item.

description
string or null [ 0 .. 2000 ] characters

Optional longer description.

category
string or null [ 0 .. 100 ] characters

Optional category (e.g. Electronics, Furniture).

notes
string or null [ 0 .. 2000 ] characters

Optional free-form notes.

Responses

Request samples

Content type
application/json
{
  • "roomId": 1,
  • "name": "Vintage Lamp",
  • "description": "Brass table lamp, 1980s",
  • "category": "Electronics",
  • "notes": "Needs new shade"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "roomId": 1,
  • "name": "Vintage Lamp",
  • "description": "Brass table lamp, 1980s",
  • "category": "Electronics",
  • "notes": "Needs new shade",
  • "createdAtUtc": "2024-01-15T10:30:00Z",
  • "updatedAtUtc": "2024-02-01T14:00:00Z"
}

Locations

Creates a new location.

Creates a new location.

Authorizations:
oidc
Request Body schema: application/json
required
name
required
string [ 1 .. 200 ] characters

Display name of the location (e.g. home, office).

description
string or null [ 0 .. 2000 ] characters

Optional description of the location.

Responses

Request samples

Content type
application/json
{
  • "name": "Home",
  • "description": "Main residence"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Home",
  • "description": "Main residence",
  • "createdAtUtc": "2024-01-15T10:30:00Z",
  • "updatedAtUtc": "2024-02-01T14:00:00Z"
}

Returns all locations.

Returns all locations.

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes a location by id.

Deletes a location by id.

Authorizations:
oidc
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

Returns a single location by id.

Returns a single location by id.

Authorizations:
oidc
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Home",
  • "description": "Main residence",
  • "createdAtUtc": "2024-01-15T10:30:00Z",
  • "updatedAtUtc": "2024-02-01T14:00:00Z"
}

Updates an existing location by id.

Updates an existing location by id.

Authorizations:
oidc
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]
Request Body schema: application/json
required
name
required
string [ 1 .. 200 ] characters

Display name of the location (e.g. home, office).

description
string or null [ 0 .. 2000 ] characters

Optional description of the location.

Responses

Request samples

Content type
application/json
{
  • "name": "Home",
  • "description": "Main residence"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Home",
  • "description": "Main residence",
  • "createdAtUtc": "2024-01-15T10:30:00Z",
  • "updatedAtUtc": "2024-02-01T14:00:00Z"
}

Rooms

Creates a new room.

Creates a new room.

Authorizations:
oidc
Request Body schema: application/json
required
locationId
integer <int32> [ 1 .. 2147483647 ]

Id of the parent location.

name
required
string [ 1 .. 200 ] characters

Display name of the room (e.g. Living Room, Garage).

description
string or null [ 0 .. 2000 ] characters

Optional description of the room.

Responses

Request samples

Content type
application/json
{
  • "locationId": 1,
  • "name": "Living Room",
  • "description": "Main gathering space"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "locationId": 1,
  • "name": "Living Room",
  • "description": "Main gathering space",
  • "createdAtUtc": "2024-01-15T10:30:00Z",
  • "updatedAtUtc": "2024-02-01T14:00:00Z"
}

Returns all rooms.

Returns all rooms.

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes a room by id.

Deletes a room by id.

Authorizations:
oidc
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

Returns a single room by id.

Returns a single room by id.

Authorizations:
oidc
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "locationId": 1,
  • "name": "Living Room",
  • "description": "Main gathering space",
  • "createdAtUtc": "2024-01-15T10:30:00Z",
  • "updatedAtUtc": "2024-02-01T14:00:00Z"
}

Updates an existing room by id.

Updates an existing room by id.

Authorizations:
oidc
path Parameters
id
required
integer <int32> [ 1 .. 2147483647 ]
Request Body schema: application/json
required
locationId
integer <int32> [ 1 .. 2147483647 ]

Id of the parent location.

name
required
string [ 1 .. 200 ] characters

Display name of the room (e.g. Living Room, Garage).

description
string or null [ 0 .. 2000 ] characters

Optional description of the room.

Responses

Request samples

Content type
application/json
{
  • "locationId": 1,
  • "name": "Living Room",
  • "description": "Main gathering space"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "locationId": 1,
  • "name": "Living Room",
  • "description": "Main gathering space",
  • "createdAtUtc": "2024-01-15T10:30:00Z",
  • "updatedAtUtc": "2024-02-01T14:00:00Z"
}

Test

Test endpoint that returns a greeting.

Test endpoint that returns a greeting.

Authorizations:
oidc

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}