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.

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:

{
  "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.

Parâmetros	Tipo	Descrição
display_children	Boolean!	Define se as subpastas serão incluídas. O valor padrão é true.
limit	Int!	Quantidade de pastas retornadas por página.
page	Int!	Página que será consultada.
type	FolderTypeEnum	Filtra pelo tipo da pasta.
search	String	Pesquisa uma pasta pelo nome.
orderBy	OrderBy	Define o campo e a direção da ordenação.

Buscando uma pasta

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

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:

{
  "documentId": "UUID_DO_DOCUMENTO"
}

Você pode conferir o que é cada um desses parâmetros direto na documentação completa da API GraphQL, no menu Docs do Altair. Se você não sabe como fazer isso, confira o nosso tutorial em Usando o Altair

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/