# List models

Endpoint: GET /models
Version: v3
Security: oauth2

## Query parameters:

  - `rootModel` (string,null)
    Root model to get dependencies from

  - `includeModelDefinitions` (boolean)
    When true, the response includes the model definitions

## Response 200 fields (application/json):

  - `id` (string)
    Id of the Model.
    Example: "dtmi:com:willowinc:Room;1"

  - `displayName` (object,null)
    Display Names of the Model keyed by language code.
    Example: {"en":"Room"}

  - `description` (object,null)
    Description of the Model keyed by language code.
    Example: {"en":"A portion of space within a building that's usually enclosed and has its own walls, floor, and ceiling."}

  - `modelDefinition` (string)
    Encoded JSON string of DTDL model definition.
    Example: "{\"@id\":\"dtmi:com:willowinc:Room;1\",\n    \"@type\":\"Interface\",\n    \"displayName\":{\"en\":\"Room\"},\n    \"description\":{\"en\":\"A portion of space within a building that's usually enclosed and has its own walls, floor, and ceiling.\"},\n    \"extends\":[\"dtmi:com:willowinc:Space;1\"],\n    \"contents\":[{\n        \"@type\":\"Property\",\n        \"name\":\"type\",\n        \"displayName\":{\"en\":\"Type\"},\n        \"writable\": true,\n        \"schema\":\"string\"\n      },\n      {\n        \"@type\":[\"Property\",\"Volume\"],\n        \"name\":\"volume\",\n        \"displayName\":{\"en\":\"Volume\"},\n        \"writable\": true,\n        \"schema\":\"double\",\n        \"unit\":\"cubicMetre\"\n      },\n      {\n        \"@type\":[\"Property\",\"ValueAnnotation\",\"Override\"],\n        \"displayName\":{\"en\":\"volume unit\"},\n        \"name\":\"volumeUnit\",\n        \"annotates\":\"volume\",\n        \"overrides\":\"unit\",\n        \"schema\":\"VolumeUnit\",\n        \"writable\": true\n      }\n    ],\n    \"@context\":[\n      \"dtmi:dtdl:context;3\",\n      \"dtmi:dtdl:extension:quantitativeTypes;1\",\n      \"dtmi:dtdl:extension:annotation;1\",\n      \"dtmi:dtdl:extension:overriding;1\"\n    ]\n  }"

  - `uploadTime` (string,null)
    Timestamp when the model was uploaded in ISO 8601 format
    Example: "2024-08-30T03:33:54.7015118+00:00"

## Response 400 fields (application/json):

  - `type` (string,null)

  - `title` (string,null)

  - `status` (integer,null)

  - `detail` (string,null)

  - `instance` (string,null)