---
title: "List folders"
method: GET
path: "/catalog/v1/folders"
tags: ["Folders"]
---

# List folders

`GET /catalog/v1/folders`

## Request

- Base URL: `https://your-environment.ataccama.one/api`
- URL: `https://your-environment.ataccama.one/api/catalog/v1/folders`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/docs/catalog/v1/folders/get.ts> (a function with typed inputs; its response is checked against the schema)

List the folders.

To list the catalog items placed in a folder, use [List catalog items](#tag/catalog-items/GET/catalog/v1/catalog-items) with the `parentUrn` query parameter.

Paging is forward-only.

## Query parameters

- `after` string
- `size` integer
- `parentUrn` string, uri: URN of the folder's parent. A folder is nested either directly under a source or under another folder, forming a recursive hierarchy. Format: urn:ata:{tenant}:catalog:source:{uuid} or urn:ata:{tenant}:catalog:folder:{uuid} Example values: - urn:ata:acme-corp:catalog:source:28e3ca71-635b-43c4-9d1b-bc9cc642721f - urn:ata:acme-corp:catalog:folder:123e4567-e89b-12d3-a456-426614174000
- `search` string
- `name` string
- `sort` string[]
- `extraProperties` string[]

## Response `200`

Paginated list of folders.

- object
  - `meta` PaginationMetadata
    - `next` string: Encoded string representing the next page. Omitted if there are no more pages.
    - `total` integer: Total number of items available across all pages.
  - `data` Folder[]
    - `urn` string, uri, required: A URN identifying a Folder resource in the Catalog API. Format: urn:ata:{tenant}:catalog:folder:{uuid} Example: urn:ata:acme-corp:catalog:folder:123e4567-e89b-12d3-a456-426614174000.
    - `name` string, required: Name of the folder.
    - `description` string: Description of the folder.
    - `parentUrn` string, uri, required: URN of the folder's parent. A folder is nested either directly under a source or under another folder, forming a recursive hierarchy. Format: urn:ata:{tenant}:catalog:source:{uuid} or urn:ata:{tenant}:catalog:folder:{uuid} Example values: - urn:ata:acme-corp:catalog:source:28e3ca71-635b-43c4-9d1b-bc9cc642721f - urn:ata:acme-corp:catalog:folder:123e4567-e89b-12d3-a456-426614174000
    - `extraProperties` ExtraProperties: A map of properties associated with the entity defined in the metadata model. Only scalar and reference properties are supported, including arrays. In responses, only properties explicitly requested via the `extraProperties` query parameter are included. In `PATCH` requests, only the properties listed in the body are modified; set a property to `null` (for scalars) or `[]` (for reference arrays) to clear its value. To find which extra properties are available for an entity, retrieve its entity definition through the Metadata model entities endpoints: `catalogItem` for catalog items, `attribute` for catalog attributes, `source` for sources, `folder` for folders, and the term's own `type` (for example, `businessTerm`) for terms.

## Other responses

- `400`: Bad request. The request parameters or body are invalid.
- `403`: Forbidden. You do not have permission to access the requested resource.

---

[API](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api.md) - [All operations](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/revisions/46f16e0487f8?raw)