v1Recursos/Dados/getListar pastas

Listar pastas

Retorna todas as pastas desta agência, com sua contagem de itens e mistura de origens.

get/api/v1/folders

media:read

Parâmetros de consulta

scopeTypestring (account | client | location | brand)opcional

Restringir a pastas com este escopo: account, client, location ou brand.

scopeIdstringopcional

Restringir a pastas com este id de escopo. Requer scopeType.

Resposta

dataobjectopcional

itemsarray of objectopcional

idstringopcional

Identificador único da pasta.

namestringopcional

O nome da pasta.

descriptionstringopcional

A descrição da pasta, ou null.

itemCountnumberopcional

Número de assets atualmente na pasta.

sourceMixarray of stringopcional

As origens de assets distintas presentes na pasta.

scopeobjectopcional

O escopo da pasta, ou null quando vale para toda a agência.

typestring (account | client | location | brand)opcional

idstringopcional

sharingobjectopcional

O estado de compartilhamento público da pasta.

accessstring (restricted | link)opcional

urlstringopcional

createdAtstringopcional

Quando a pasta foi criada, como timestamp ISO 8601.

Erros

401Chave de API ausente, inválida, expirada ou revogada.

403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

get/api/v1/folders

Sua chave de API

scopeType

scopeId

{
  "data": {
    "items": [
      {
        "id": "folder_1",
        "name": "Storefront Photos",
        "description": null,
        "itemCount": 12,
        "sourceMix": [
          "upload",
          "gmb"
        ],
        "scope": {
          "type": "client",
          "id": "cli_123"
        },
        "sharing": {
          "access": "restricted",
          "url": null
        },
        "createdAt": "2026-01-15T10:00:00.000Z"
      }
    ]
  }
}