Skip to main content
GET
/
models
/
views
Python SDK
view_list = client.data_modeling.views.list(limit=5)

for view in client.data_modeling.views:
    view # do something with the view

for view_list in client.data_modeling.views(chunk_size=10):
    view_list # do something with the views
{
  "items": [
    {
      "externalId": "<string>",
      "space": "<string>",
      "version": "<string>",
      "createdTime": 1730204346000,
      "lastUpdatedTime": 1730204346000,
      "writable": true,
      "queryable": true,
      "usedFor": "node",
      "isGlobal": true,
      "properties": {},
      "mappedContainers": [
        {
          "type": "container",
          "space": "<string>",
          "externalId": "<string>"
        }
      ],
      "name": "<string>",
      "description": "<string>",
      "filter": {
        "and": [
          {
            "in": {
              "property": [
                "tag"
              ],
              "values": [
                10011,
                10011
              ]
            }
          },
          {
            "range": {
              "property": [
                "weight"
              ],
              "gte": 0
            }
          }
        ]
      },
      "implements": [
        {
          "type": "view",
          "space": "<string>",
          "externalId": "<string>",
          "version": "<string>"
        }
      ]
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Query Parameters

limit
integer
default:10

Limit the number of results returned. The largest result-set returned by the server will be 1000 items, even if you specify a higher limit.

Required range: 1 <= x <= 1000
cursor
string

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Example:

"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"

space
string

The space to query.

Required string length: 1 - 43
Pattern: (?!^(space|cdf|dms|pg3|shared|system|node|edge)$)(^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$)
Example:

"timeseries"

includeInheritedProperties
boolean
default:true

Include properties inherited from views this view implements.

allVersions
boolean
default:false

If all versions of the entity should be returned. Defaults to false which returns the latest version, attributed to the newest 'createdTime' field

includeGlobal
boolean
default:false

If the global items of the entity should be returned. Defaults to false which excludes global items.

Response

List of views

items
object[]
required

List of views

nextCursor
string

The cursor value used to return (paginate to) the next page of results, when more data is available.

Last modified on April 23, 2026