> For the complete documentation index, see [llms.txt](https://docs.hiboo.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hiboo.io/rest-api-reference/fleet-identity/fleet.md).

# Fleet

The following endpoints allow you to retrieve the list of all equipments and manage their identity.

## Fleet

> Returns the list of all equipments and their identity. This endpoint is paginated.

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Fleet","description":"The following endpoints allow you to retrieve the list of all equipments and manage their identity."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"parameters":{"limit":{"name":"limit","in":"query","description":"The numbers of items to return","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":50}},"offset":{"name":"offset","in":"query","description":"The number of items to skip before starting to collect the result set","required":false,"schema":{"type":"integer","format":"int32","default":0}},"includeCustomFields":{"name":"includeCustomFields","in":"query","description":"By default, customFields are not included. If set to one, the custom fields will be included in the response","required":false,"schema":{"type":"integer","format":"int32","default":0}},"includeDataSources":{"name":"includeDataSources","in":"query","description":"By default, data sources related to the equipment are not included. If set to one, the data sources will be included in the response","required":false,"schema":{"type":"integer","format":"int32","default":0}},"includeGroup":{"name":"includeGroup","in":"query","description":"By default, equipment group information is not included. If set to one, the group information will be included in the response","required":false,"schema":{"type":"integer","format":"int32","default":0}},"FilterByInProgressSharing":{"name":"filterByInProgressSharing","in":"query","description":"This parameter allows filtering the equipments based on whether the equipment is currently involved in an in-progress sharing process or not.","required":false,"schema":{"type":"integer"}}},"responses":{"Equipments":{"description":"List of equipment","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"make":{"type":"string"},"model":{"type":"string"},"serialNumber":{"type":"string"},"pin":{"type":"string","nullable":true,"description":"Product Identification Number"},"vin":{"type":"string","nullable":true,"description":"Vehicle Identification Number"},"workspaces":{"type":"array","items":{"type":"string"}},"customFields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"group":{"type":"object","properties":{"id":{"type":"integer"},"assetIds":{"type":"array","items":{"type":"integer"}}}}}}}}}}}}}},"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}},"schemas":{"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}}}},"paths":{"/v2/fleet/equipments":{"get":{"operationId":"getFleetEquipments","summary":"Fleet","description":"Returns the list of all equipments and their identity. This endpoint is paginated.","tags":["Fleet"],"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/includeCustomFields"},{"$ref":"#/components/parameters/includeDataSources"},{"$ref":"#/components/parameters/includeGroup"},{"$ref":"#/components/parameters/FilterByInProgressSharing"}],"responses":{"200":{"$ref":"#/components/responses/Equipments"},"401":{"$ref":"#/components/responses/401Error"}}}}}}
```

## Archived Equipments

> Returns the list of archived equipments. This endpoint is paginated.

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Fleet","description":"The following endpoints allow you to retrieve the list of all equipments and manage their identity."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"parameters":{"limit":{"name":"limit","in":"query","description":"The numbers of items to return","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":50}},"offset":{"name":"offset","in":"query","description":"The number of items to skip before starting to collect the result set","required":false,"schema":{"type":"integer","format":"int32","default":0}}},"responses":{"Archived":{"description":"List of archived equipment","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"archiveComment":{"type":"string","description":"A comment about why the equipment was archived"},"archiveDate":{"type":"string","description":"The date at which the equipment was last archived serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ)","format":"date-time"}}}}}}}}}}},"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}},"schemas":{"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}}}},"paths":{"/v2/fleet/equipments/archived":{"get":{"operationId":"getArchivedFleetEquipments","summary":"Archived Equipments","description":"Returns the list of archived equipments. This endpoint is paginated.","tags":["Fleet"],"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"}],"responses":{"200":{"$ref":"#/components/responses/Archived"},"401":{"$ref":"#/components/responses/401Error"}}}}}}
```

## Equipment

> Returns the identity of the requested equipment

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Fleet","description":"The following endpoints allow you to retrieve the list of all equipments and manage their identity."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"parameters":{"includeCustomFields":{"name":"includeCustomFields","in":"query","description":"By default, customFields are not included. If set to one, the custom fields will be included in the response","required":false,"schema":{"type":"integer","format":"int32","default":0}}},"responses":{"Equipment":{"description":"List of equipment","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"make":{"type":"string"},"model":{"type":"string"},"serialNumber":{"type":"string"},"pin":{"type":"string","nullable":true,"description":"Product Identification Number"},"vin":{"type":"string","nullable":true,"description":"Vehicle Identification Number"},"workspaces":{"type":"array","items":{"type":"string"}},"customFields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}}}}}}},"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}},"schemas":{"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}}}},"paths":{"/v2/fleet/equipments/{id}":{"get":{"operationId":"getFleetEquipment","summary":"Equipment","description":"Returns the identity of the requested equipment","tags":["Fleet"],"parameters":[{"name":"id","in":"path","description":"ID of the equipment","required":true,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/includeCustomFields"}],"responses":{"200":{"$ref":"#/components/responses/Equipment"},"401":{"$ref":"#/components/responses/401Error"}}}}}}
```

## Delete an equipment

> Marks the specified equipment as deleted. The equipment must be archived before it can be mark as deleted.

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Fleet","description":"The following endpoints allow you to retrieve the list of all equipments and manage their identity."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"responses":{"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"403Error":{"description":"Insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"404Error":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}},"schemas":{"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}}}},"paths":{"/v2/fleet/equipments/{id}":{"delete":{"operationId":"deleteFleetEquipment","summary":"Delete an equipment","description":"Marks the specified equipment as deleted. The equipment must be archived before it can be mark as deleted.","tags":["Fleet"],"parameters":[{"name":"id","in":"path","description":"ID of the equipment","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Equipment deleted successfully (no content)"},"401":{"$ref":"#/components/responses/401Error"},"403":{"$ref":"#/components/responses/403Error"},"404":{"$ref":"#/components/responses/404Error"},"409":{"description":"Equipment cannot be deleted unless it is archived first, or if it is currently involved in an in progress sharing process."}}}}}}
```

## Get equipment status

> Returns the current status of the specified equipment. The response includes metadata depending on the status

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Fleet","description":"The following endpoints allow you to retrieve the list of all equipments and manage their identity."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"responses":{"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"403Error":{"description":"Insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"404Error":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}},"schemas":{"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}}}},"paths":{"/v2/fleet/equipments/{id}/status":{"get":{"operationId":"getFleetEquipmentStatus","summary":"Get equipment status","description":"Returns the current status of the specified equipment. The response includes metadata depending on the status","tags":["Fleet"],"parameters":[{"name":"id","in":"path","description":"ID of the equipment","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Equipment status retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["archived","deleted","active"],"description":"Current status of the equipment"},"metadata":{"type":"object","nullable":true,"description":"Additional metadata depending on the status","properties":{"date":{"type":"string","format":"date-time","description":"Timestamp when the status change occurred"},"comment":{"type":"string","description":"Comment associated with archiving (only present if status is archived)"}}}},"required":["status"]}}}},"401":{"$ref":"#/components/responses/401Error"},"403":{"$ref":"#/components/responses/403Error"},"404":{"$ref":"#/components/responses/404Error"}}}}}}
```

## Archive an equipment

> Marks the specified equipment as archived. Archived equipment will no longer be active, but can be restored later using the \`/status/active\` endpoint.

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Fleet","description":"The following endpoints allow you to retrieve the list of all equipments and manage their identity."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"responses":{"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"403Error":{"description":"Insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"404Error":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}},"schemas":{"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}}}},"paths":{"/v2/fleet/equipments/{id}/status/archived":{"post":{"operationId":"archiveFleetEquipment","summary":"Archive an equipment","description":"Marks the specified equipment as archived. Archived equipment will no longer be active, but can be restored later using the `/status/active` endpoint.","tags":["Fleet"],"parameters":[{"name":"id","in":"path","description":"ID of the equipment","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["comment"],"properties":{"comment":{"type":"string","description":"Reason or note for archiving the equipment"}}}}}},"responses":{"204":{"description":"Equipment archived successfully (no content)"},"401":{"$ref":"#/components/responses/401Error"},"403":{"$ref":"#/components/responses/403Error"},"404":{"$ref":"#/components/responses/404Error"},"409":{"description":"Equipment must be active before it can be archived"}}}}}}
```

## Unarchive an equipment

> Restores a previously archived equipment to active status.

```json
{"openapi":"3.0.3","info":{"title":"Hiboo API","version":"2.0.0"},"tags":[{"name":"Fleet","description":"The following endpoints allow you to retrieve the list of all equipments and manage their identity."}],"servers":[{"url":"https://api.hiboo.io","description":"Production server"},{"url":"https://api-sandbox.hiboo.io","description":"Sandbox server"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"x-access-token","description":"Generate a JWT when you log in. Use it in your following requests in the header as `x-access-token: your-token-here`\n"}},"responses":{"401Error":{"description":"Unable to authenticate the token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"403Error":{"description":"Insufficient permissions to access the resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}},"404Error":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoDetailError"}}}}},"schemas":{"NoDetailError":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"A human readable description of the error"}}}}},"paths":{"/v2/fleet/equipments/{id}/status/active":{"post":{"operationId":"unarchiveFleetEquipment","summary":"Unarchive an equipment","description":"Restores a previously archived equipment to active status.","tags":["Fleet"],"parameters":[{"name":"id","in":"path","description":"ID of the equipment","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Equipment unarchived successfully (no content)"},"401":{"$ref":"#/components/responses/401Error"},"403":{"$ref":"#/components/responses/403Error"},"404":{"$ref":"#/components/responses/404Error"},"409":{"description":"Equipment must be archived before it can be unarchived"}}}}}}
```