List package notebooks

Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.

GET /environments/{environmentName}/packages/{packageName}/notebooks

List package notebooks

cURL

curl --request GET \
  --url https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/packages/{packageName}/notebooks \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "resource": "<string>",
    "packageName": "<string>",
    "path": "<string>",
    "error": "<string>"
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentName · string · required

Name of the environment Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$

packageName · string · required

Name of the package Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$

Query Parameters

versionId · string

Version identifier for the package Version identifier pattern supporting dots and dashes

Pattern: ^[a-zA-Z0-9_.-]+$

Response

200

application/json

A list of models in the package

resource · string

Resource path to the notebook

packageName · string

Name of the package containing this notebook

path · string

Relative path to the notebook file within its package directory

error · string

Error message if the notebook failed to compile or load