> ## Documentation Index > Fetch the complete documentation index at: https://docs-xcor.paloaltonetworks.com/llms.txt > Use this file to discover all available pages before exploring further. # ListNotebooks ## OpenAPI ````yaml openapi/api_v1_config_openapi3_DOCUMENTATION_ONLY.json GET /api/v1/config/notebooks openapi: 3.0.3 info: description: > The Config API provides standard HTTP/JSON REST endpoints for creating, reading, updating, deleting, and listing configurable Chronosphere resources. Use this link to download the raw Swagger specification: /api/v1/config/swagger.json title: Config V1 API version: v1 servers: - url: https://{tenant}.chronosphere.io variables: tenant: default: tenant description: tenant ID assigned by the service provider security: - ApiKeyAuth: [] tags: - name: ConfigV1 paths: /api/v1/config/notebooks: get: tags: - Notebook operationId: ListNotebooks parameters: - description: >- Sets the preferred number of items to return per page. If set to `0`, the server will use its default value. Regardless of the value specified, clients must never assume how many items will be returned. in: query name: page.max_size schema: format: int64 type: integer - description: >- An opaque page token that identifies which page the client should request. An empty value indicates the first page. in: query name: page.token schema: type: string - description: >- Filters results by slug, where any Notebook with a matching slug in the given list (and matches all other filters) will be returned. in: query name: slugs schema: items: type: string type: array - description: >- Slugs of SIMPLE collections. Notebooks in service or user collections are not matched by this filter. in: query name: collection_slugs schema: items: type: string type: array - description: >- Filters results by name, where any Notebook with a matching name in the given list (and matches all other filters) will be returned. in: query name: names schema: items: type: string type: array - description: >- Optional flag to populate the notebook_json of the returned notebooks. By default, notebook_json will be left empty. in: query name: include_notebook_json schema: type: boolean responses: '200': content: application/json: schema: $ref: '#/components/schemas/configv1ListNotebooksResponse' description: A successful response. '500': content: application/json: schema: $ref: '#/components/schemas/apiError' description: An unexpected error response. default: content: application/json: schema: $ref: '#/components/schemas/genericError' description: An undefined error response. components: schemas: configv1ListNotebooksResponse: properties: notebooks: items: $ref: '#/components/schemas/configv1Notebook' type: array page: $ref: '#/components/schemas/configv1PageResult' type: object apiError: properties: message: description: An error message describing what went wrong. type: string type: object genericError: additionalProperties: true type: object configv1Notebook: properties: collection: allOf: - $ref: '#/components/schemas/configv1CollectionReference' description: >- Collection the notebook belongs to. Required if `collection_slug` isn't set. collection_slug: description: >- Slug of the collection the notebook belongs to. Required if `collection` isn't set. type: string created_at: description: >- Timestamp of when the Notebook was created. Cannot be set by clients. format: date-time readOnly: true type: string labels: additionalProperties: type: string description: Optional. Defines tags that add metadata about the notebook. type: object name: description: >- The name of the Notebook. You can modify this value after the Notebook is created. type: string notebook_json: description: Required raw JSON of the notebook. type: string slug: description: >- The unique identifier of the Notebook. If a `slug` isn't provided, one is generated based on the `name` field. You can't modify this field after the Notebook is created. type: string updated_at: description: >- Timestamp of when the Notebook was last updated. Cannot be set by clients. format: date-time readOnly: true type: string required: - name type: object configv1PageResult: properties: next_token: description: |- An opaque page token that identifies the next page of items that the client should request. An empty value indicates that there are no more items to return. type: string type: object configv1CollectionReference: properties: slug: type: string type: $ref: '#/components/schemas/configv1CollectionReferenceType' type: object configv1CollectionReferenceType: description: |- Type values must match entitiespb.Collection.CollectionType. - USER: A user's personal collection. Only notebooks and dashboards can be owned by a user collection; other entity types, Grafana dashboards included, reject a USER owner with a 400. enum: - SIMPLE - SERVICE - USER type: string securitySchemes: ApiKeyAuth: description: Chronosphere API token in: header name: API-Token type: apiKey ```` ## Related topics - [Use notebooks to gather related information](https://docs-xcor.paloaltonetworks.com/navigate/notebooks.md) - [Team and collection home pages](https://docs-xcor.paloaltonetworks.com/administer/collections/home.md) - [CreateNotebook](https://docs-xcor.paloaltonetworks.com/tooling/api-info/definition/operations/CreateNotebook.md) - [UpdateNotebook](https://docs-xcor.paloaltonetworks.com/tooling/api-info/definition/operations/UpdateNotebook.md) - [ReadNotebook](https://docs-xcor.paloaltonetworks.com/tooling/api-info/definition/operations/ReadNotebook.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.