---
updatedAt: 2026-06-12T14:47:10.000Z
agentTools:
  projectIndex: https://docs.formant.io/llms.txt
---

# Get views

List device views
Resource: views
Authorized roles: device

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "Filter": {
        "properties": {
          "deviceIds": {
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array"
          },
          "names": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "types": {
            "items": {
              "type": "string",
              "enum": [
                "bitset",
                "localization",
                "point cloud",
                "location",
                "file",
                "health",
                "transform tree",
                "battery",
                "video",
                "numeric set",
                "json",
                "image",
                "numeric",
                "text"
              ]
            },
            "type": "array"
          },
          "notTags": {},
          "notNames": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "agentIds": {
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array"
          },
          "tags": {
            "title": "MultiTagSets",
            "description": "One or more TagSets (combined with OR logic)",
            "oneOf": [
              {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/TagSets"
                }
              },
              {
                "$ref": "#/components/schemas/TagSets"
              }
            ]
          }
        },
        "type": "object",
        "nullable": true
      },
      "BitsetViewConfiguration": {
        "properties": {
          "splitByKey": {
            "type": "string"
          },
          "columnWidth": {
            "type": "integer",
            "format": "int64",
            "minimum": 1,
            "maximum": 9007199254740991
          }
        },
        "type": "object"
      },
      "ImageViewConfiguration": {
        "properties": {
          "mode": {
            "type": "string",
            "enum": [
              "device",
              "time"
            ]
          }
        },
        "type": "object"
      },
      "Vector3": {
        "properties": {
          "x": {
            "type": "number"
          },
          "y": {
            "type": "number"
          },
          "z": {
            "type": "number"
          }
        },
        "type": "object",
        "required": [
          "x",
          "y",
          "z"
        ]
      },
      "Camera": {
        "properties": {
          "position": {
            "$ref": "#/components/schemas/Vector3"
          },
          "target": {
            "$ref": "#/components/schemas/Vector3"
          }
        },
        "type": "object",
        "required": [
          "position",
          "target"
        ]
      },
      "LocalizationViewConfiguration": {
        "properties": {
          "camera": {
            "$ref": "#/components/schemas/Camera"
          }
        },
        "type": "object"
      },
      "Location": {
        "properties": {
          "latitude": {
            "maximum": 90,
            "type": "number",
            "minimum": -90
          },
          "longitude": {
            "maximum": 180,
            "type": "number",
            "minimum": -180
          },
          "altitude": {
            "type": "number"
          },
          "orientation": {
            "type": "number"
          }
        },
        "type": "object",
        "required": [
          "latitude",
          "longitude"
        ]
      },
      "LocationViewport": {
        "properties": {
          "center": {
            "$ref": "#/components/schemas/Location"
          },
          "zoom": {
            "maximum": 20,
            "type": "number",
            "minimum": 1
          }
        },
        "type": "object",
        "required": [
          "center",
          "zoom"
        ]
      },
      "LocationViewConfiguration": {
        "properties": {
          "basemap": {
            "type": "string",
            "enum": [
              "streets",
              "satellite"
            ]
          },
          "viewport": {
            "$ref": "#/components/schemas/LocationViewport"
          }
        },
        "type": "object"
      },
      "NumericViewConfiguration": {
        "properties": {
          "span": {
            "type": "integer",
            "format": "int64",
            "minimum": 1,
            "maximum": 9007199254740991
          },
          "splitByKey": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "PointCloudViewConfiguration": {
        "properties": {
          "camera": {
            "$ref": "#/components/schemas/Camera"
          }
        },
        "type": "object"
      },
      "TransformTreeViewConfiguration": {
        "properties": {
          "camera": {
            "$ref": "#/components/schemas/Camera"
          }
        },
        "type": "object"
      },
      "ViewConfiguration": {
        "properties": {
          "streamName": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "bitset",
              "localization",
              "point cloud",
              "location",
              "file",
              "health",
              "transform tree",
              "battery",
              "video",
              "numeric set",
              "json",
              "image",
              "numeric",
              "text"
            ]
          },
          "configuration": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/BitsetViewConfiguration"
              },
              {
                "$ref": "#/components/schemas/ImageViewConfiguration"
              },
              {
                "$ref": "#/components/schemas/LocationViewConfiguration"
              },
              {
                "$ref": "#/components/schemas/NumericViewConfiguration"
              },
              {
                "$ref": "#/components/schemas/NumericViewConfiguration"
              },
              {
                "$ref": "#/components/schemas/NumericViewConfiguration"
              },
              {
                "$ref": "#/components/schemas/LocalizationViewConfiguration"
              },
              {
                "$ref": "#/components/schemas/PointCloudViewConfiguration"
              },
              {
                "$ref": "#/components/schemas/TransformTreeViewConfiguration"
              }
            ]
          }
        },
        "type": "object",
        "required": [
          "streamName",
          "type",
          "configuration"
        ]
      },
      "View": {
        "properties": {
          "organizationId": {
            "format": "uuid",
            "type": "string"
          },
          "name": {
            "maxLength": 255,
            "type": "string"
          },
          "description": {
            "maxLength": 1024,
            "type": "string",
            "nullable": true
          },
          "url": {
            "maxLength": 2000,
            "type": "string",
            "nullable": true
          },
          "showOnSingleDevice": {
            "type": "boolean"
          },
          "showOnMultiDevice": {
            "type": "boolean"
          },
          "showOnTeleop": {
            "type": "boolean"
          },
          "showTimeline": {
            "type": "boolean"
          },
          "localModeEnabled": {
            "type": "boolean"
          },
          "filter": {
            "$ref": "#/components/schemas/Filter",
            "nullable": true
          },
          "deviceFilter": {
            "$ref": "#/components/schemas/Filter",
            "nullable": true
          },
          "groupFilter": {
            "$ref": "#/components/schemas/Filter",
            "nullable": true
          },
          "layout": {},
          "layoutType": {
            "type": "string",
            "enum": [
              "dashboard",
              "observe",
              "fullscreen",
              "analytics",
              "teleop"
            ],
            "nullable": true
          },
          "configuration": {
            "items": {
              "$ref": "#/components/schemas/ViewConfiguration"
            },
            "type": "array"
          },
          "smartFleetId": {
            "nullable": true,
            "format": "uuid",
            "type": "string"
          },
          "index": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "tags": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "type": "object",
        "required": [
          "name",
          "layout",
          "configuration",
          "index",
          "filter",
          "deviceFilter",
          "groupFilter"
        ]
      },
      "ViewListResponse": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/View"
            },
            "type": "array"
          }
        },
        "type": "object",
        "required": [
          "items"
        ]
      },
      "TagSets": {
        "title": "TagSets",
        "description": "A map of tag keys to an array of values",
        "type": "object",
        "additionalProperties": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "info": {
    "title": "Formant admin-api",
    "version": "1.357.8"
  },
  "openapi": "3.0.0",
  "paths": {
    "/devices/{id}/views": {
      "get": {
        "operationId": "DeviceController.getViews",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ViewListResponse"
                }
              }
            },
            "description": ""
          }
        },
        "summary": "Get views",
        "tags": [
          "Device"
        ],
        "description": "List device views\nResource: views\nAuthorized roles: device",
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.formant.io/v1/admin"
    }
  ]
}
```