Equipments

Name
id
Type
string
Description
Unique identifier for the equipment.
Name
name
Type
string
Description
The name of the equipment.
Name
description
Type
string
Description
The description of the equipment.
Name
location_id
Type
string
Description
The id of the location the equipment is attached to.
Name
qrcode_url
Type
string
Description
The QR code URL of the equipment.
Name
serial
Type
string
Description
The serial number of the equipment.
Name
fields
Type
array
Description
The custom fields of locations.

GET/api/v3.0/equipments

Equipments List

This endpoint allows you to retrieve a list of tickets.

optional parameters

Name
cursor
Type
string
Description
Cursor to paginate the results.

Request

GET

/api/v3.0/equipments

curl -G https://api.bob-desk.com/api/v3.0/equipments \
  -H "Authorization: Bearer {token}" \
  -d cursor="63725f259ab7e72a4fb4ae69" \

Response

{
    "cursor": "63725f259ab7e72a4fb4ae69",
    "equipments": [
        {
            "_id": "63725f259ab7e72a4fb4ae69",
            "name": "Laptop",
            "description": "Macbook Pro 2021",
            "location_id": "63725f259ab7e72a4fb4ae69",
            "qrcode_url": "https://images.bob-desk.com/awesome-qrcode.png",
            "serial": "123456789",
            "fields": [
                {
                    "field_id": "63725f259ab7e72a4fb4ae69",
                    "name": {
                        "fr": "Surface"
                    }
                    "value": "customValue"
                }
            ]
        }
    ]
}

POST/api/v3.0/equipments

Create equipment

This endpoint allows you to create a ticket.

Required parameters

Name
name
Type
string
Description
Name of the equipment.
Name
location_id
Type
array
Description
The id of the location the equipment is attached to.

Optional parameters

Name
description
Type
string
Description
Description of the equipment.
Name
model
Type
string
Description
Model of the equipment.
Name
serial
Type
string
Description
Serial number of the equipment.
Name
fields
Type
array
Description
The custom fields of locations.

Request

POST

/api/v3.0/equipments

curl -X https://api.bob-desk.com/api/v3.0/equipments \
  -H "Content-Type: application/json"
  -H "Authorization: Bearer {token}" \
  -d '{
    "title": "Accounting laptop",
    "description": "Old laptop",
    "location_id": "5d9b5b5b9ab7e72a4fb4ae69",
    "model": "Macbook Pro 2021",
    "serial": "123456789",
    "fields": [
        {
            "field_id": "63826f259ab7e54a4fb4ae12",
            "value": "1000"
        }
    ]
    }'

Response

{
    "id": "5f9b5b5b9ab7e72a4fb4ae69",
    "name": "Accounting laptop",
    "description": "Old laptop",
    "location_id": "5d9b5b5b9ab7e72a4fb4ae69",
    "qrcode_url": "https://images.bob-desk.com/awesome-qrcode.png",
    "model": "Macbook Pro 2021",
    "serial": "123456789",
    "fields": [
        {
            "field_id": "63826f259ab7e54a4fb4ae12",
            "name": {
                "fr": "prix"
            }
            "value": "customValue"
        }
    ]
}