> For the complete documentation index, see [llms.txt](https://docs.autentique.com.br/api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.autentique.com.br/api/2/queries/listando-pastas.md).

# Listando Pastas

Como listar as pastas de sua conta

Use a query `folders` para consultar as pastas disponíveis. O resultado é paginado e pode incluir as subpastas de cada item.

```graphql
query ListFolders(
  $limit: Int!
  $page: Int!
  $displayChildren: Boolean!
  $search: String
  $orderBy: OrderBy
) {
  folders(
    limit: $limit
    page: $page
    display_children: $displayChildren
    search: $search
    orderBy: $orderBy
  ) {
    data {
      id
      name
      path
      context
      children_counter
      is_editor
      created_at
      updated_at
      subfolders {
        id
        name
        path
      }
    }
    total
    current_page
    last_page
    has_more_pages
  }
}
```

Variáveis:

```json
{
  "limit": 20,
  "page": 1,
  "displayChildren": true,
  "search": null,
  "orderBy": {
    "field": "created_at",
    "direction": "DESC"
  }
}
```

O parâmetro `display_children` define se as subpastas serão carregadas junto com cada pasta. Deixá-lo como `false` pode ser interessante quando você precisa apenas da listagem principal.

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="167.8671875">Parâmetros</th><th width="166.7265625">Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td><code>display_children</code></td><td><code>Boolean!</code></td><td>Define se as subpastas serão incluídas. O valor padrão é <code>true</code>.</td></tr><tr><td><code>limit</code></td><td><code>Int!</code></td><td>Quantidade de pastas retornadas por página.</td></tr><tr><td><code>page</code></td><td><code>Int!</code></td><td>Página que será consultada.</td></tr><tr><td><code>type</code></td><td><code>FolderTypeEnum</code></td><td>Filtra pelo tipo da pasta.</td></tr><tr><td><code>search</code></td><td><code>String</code></td><td>Pesquisa uma pasta pelo nome.</td></tr><tr><td><code>orderBy</code></td><td><code>OrderBy</code></td><td>Define o campo e a direção da ordenação.</td></tr></tbody></table>

### Buscando uma pasta

Use a query `folder` quando você já tiver o identificador da pasta e quiser consultar seus dados.

```graphql
query GetFolder($id: UUID!) {
  folder(id: $id) {
    id
    name
    path
    context
    children_counter
    is_editor
    has_password
    parentFolder {
      id
      name
    }
    subfolders {
      id
      name
      path
    }
    shares {
      id
      role
      is_by_link
      user {
        id
        name
        email
      }
      group {
        id
        name
      }
    }
    created_at
    updated_at
  }
}
```

Variáveis:

```json
{
  "documentId": "UUID_DO_DOCUMENTO"
}
```

{% hint style="info" %}
Você pode conferir o que é cada um desses parâmetros direto na documentação completa da API GraphQL, no menu Docs do [Altair](https://altair.autentique.com.br). Se você não sabe como fazer isso, confira o nosso tutorial em [Usando o Altair](/api/2/integracao/altair.md)
{% endhint %}

{% hint style="info" %}
Se o Altair não te ajuda para integrar com a API, confira alguns exemplos de como fazer essas requisições de outra forma: <https://graphql.org/graphql-js/graphql-clients/>
{% endhint %}