API docs by Redocly

Hofy API (1.0.0)

Download OpenAPI specification:

E-mail: apiteam@swagger.io License: Apache 2.0 Terms of Service

This is a Hofy API

Assets

Everything about your Assets

asset.location-updated.v1 Webhook

Request Body schema: application/json

Information about asset location changed

type
string
Value: "asset.location-updated.v1"
object (AssetLocationChanged)

Responses

Request samples

Content type
application/json
{
  • "type": "asset.location-updated.v1",
  • "message": {
    }
}

asset.created.v1 Webhook

Request Body schema: application/json

Information about asset location changed

type
string
Value: "asset.created.v1"
object (Asset)

Responses

Request samples

Content type
application/json
{
  • "type": "asset.created.v1",
  • "message": {
    }
}

asset.archived.v1 Webhook

Request Body schema: application/json

Information about asset location changed

type
string
Value: "asset.archived.v1"
object (Asset)

Responses

Request samples

Content type
application/json
{
  • "type": "asset.archived.v1",
  • "message": {
    }
}

Find asset by ID

Returns a single asset

Authorizations:
api_key

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "publicId": "ITM-FAFC118",
  • "assignedUser": {
    },
  • "assignedWarehouse": {
    },
  • "location": "with_user",
  • "serialNumber": "string",
  • "grade": "new",
  • "ownership": {
    },
  • "status": "active",
  • "product": {
    }
}

Lists all active assets

Returns a paginated list of assets

Authorizations:
api_key
query Parameters
page
integer

Page number

pageSize
integer

Page size

userId
string (UUID)
Examples: userId=123e4567-e89b-12d3-a456-426614174000

User id

category
string (ProductCategory)
Enum: "adapter" "cable" "chair" "charger" "desk" "desk_riser" "desk_tidy" "desktop" "docking_station" "dongle" "footrest" "headset" "keyboard" "laptop" "laptop_stand" "mice_trackpad" "mobile_device" "monitor" "monitor_arm" "other" "printer" "shredder" "standing_mat" "tablet" "task_light" "webcam" "wifi_range_extender" "welcome_pack"

Product category

location
string (AssetLocation)
Enum: "with_user" "at_warehouse" "with_courier" "write_off"

Item location

Responses

Response samples

Content type
application/json
{
  • "hasNext": true,
  • "pageSize": 0,
  • "page": 0,
  • "content": [
    ]
}

Lists all archived assets

Returns a paginated list of assets

Authorizations:
api_key
query Parameters
page
integer

Page number

pageSize
integer

Page size

previousUserId
string (UUID)
Examples: previousUserId=123e4567-e89b-12d3-a456-426614174000

Previous user id

category
string (ProductCategory)
Enum: "adapter" "cable" "chair" "charger" "desk" "desk_riser" "desk_tidy" "desktop" "docking_station" "dongle" "footrest" "headset" "keyboard" "laptop" "laptop_stand" "mice_trackpad" "mobile_device" "monitor" "monitor_arm" "other" "printer" "shredder" "standing_mat" "tablet" "task_light" "webcam" "wifi_range_extender" "welcome_pack"

Product category

Responses

Response samples

Content type
application/json
{
  • "hasNext": true,
  • "pageSize": 0,
  • "page": 0,
  • "content": [
    ]
}

Users

user.created.v1 Webhook

Request Body schema: application/json

Information about user creation

type
string
Value: "user.created.v1"
object (UserRef)

Request samples

Content type
application/json
{
  • "type": "user.created.v1",
  • "message": {
    }
}

user.updated.v1 Webhook

Request Body schema: application/json

Information about user creation

type
string
Value: "user.updated.v1"
object (UserRef)

Request samples

Content type
application/json
{
  • "type": "user.updated.v1",
  • "message": {
    }
}

user.offboarded.v1 Webhook

Request Body schema: application/json

Information about user creation

type
string
Value: "user.offboarded.v1"
object (UserRef)

Responses

Request samples

Content type
application/json
{
  • "type": "user.offboarded.v1",
  • "message": {
    }
}

Lists all users

Returns a paginated list of users

Authorizations:
api_key
query Parameters
page
integer

Page number

pageSize
integer

Page size

Responses

Response samples

Content type
application/json
{
  • "hasNext": true,
  • "pageSize": 0,
  • "page": 0,
  • "content": [
    ]
}

Find user by ID

Returns a single user

Authorizations:
api_key

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "publicId": "ITM-FAFC118",
  • "firstName": "string",
  • "lastName": "string",
  • "emails": [
    ],
  • "address": {
    },
  • "team": {
    },
  • "isOffboarded": true
}

Orders

order.created.v1 Webhook

Request Body schema: application/json

Information about order creation

type
string
Value: "order.created.v1"
object (Order)

Request samples

Content type
application/json
{
  • "type": "order.created.v1",
  • "message": {
    }
}

order.updated.v1 Webhook

Request Body schema: application/json

Information about order updates

type
string
Value: "order.updated.v1"
object (Order)

Request samples

Content type
application/json
{
  • "type": "order.updated.v1",
  • "message": {
    }
}

Lists all orders

Returns a paginated list of orders

Authorizations:
api_key
query Parameters
page
integer

Page number

pageSize
integer

Page size

Responses

Response samples

Content type
application/json
{
  • "hasNext": true,
  • "pageSize": 0,
  • "page": 0,
  • "content": [
    ]
}

Find order by ID

Returns a single order

Authorizations:
api_key

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "string",
  • "brand": "string",
  • "category": "adapter",
  • "status": "requested",
  • "user": {
    },
  • "items": [
    ],
  • "deliveryAddress": {
    }
}