Synupv1
Criar chave
v1Recursos/Dados/getListar assets

Listar assets

Retorna um trecho paginado do catálogo unificado de assets, do mais recente ao mais antigo — uploads, imagens geradas por IA, assets da biblioteca de mídia sincronizada, fotos importadas do GBP e mídia enviada por usuários (UGC), combinados em um único feed.

get/api/v1/assets
media:read
Parâmetros de consulta
sourcestring (all | upload | gmb | generated | discovered | ugc)opcional
Restringir a uma aba de origem: all (padrão), upload, gmb, generated, discovered ou ugc.
typestringopcional
Restringir a um tipo de asset, por exemplo image ou video.
folderIdstringopcional
Restringir a assets desta pasta.
tagstringopcional
Restringir a assets com este nome de tag.
locationIdstringopcional
Restringir a assets atribuídos a este local. Procure com GET /api/v1/locations.
clientIdstringopcional
O cliente ao qual restringir os resultados. Obrigatório se esta chave for restrita a clientes específicos e nenhum locationId for informado. Procure com GET /api/v1/clients.
qstringopcional
Buscar por título ou nome de arquivo.
cursorstringopcional
Cursor de paginação do nextCursor de uma resposta anterior.
limitnumberopcional
Máximo de itens a retornar. Padrão 60, máximo 200.
statusstring (needs_review | spam | ok | skipped)opcional
Filtro de status de moderação — só se aplica quando source é ugc: needs_review, spam, ok ou skipped.
Resposta
dataobjectopcional
itemsarray of objectopcional
A página de assets.
keystringopcional
Identificador composto do arquivo, no formato "<source>:<id>".
sourcestringopcional
Origem deste arquivo (ex.: um envio do OS em vez de uma fonte importada).
idstringopcional
O id do arquivo dentro de sua fonte.
titlestringopcional
O título do arquivo.
filenamestringopcional
O nome de arquivo original do arquivo.
mimestringopcional
O tipo MIME do arquivo.
kindstringopcional
O tipo do arquivo (foto ou vídeo).
sizeBytesnumberopcional
Tamanho do arquivo em bytes, ou null se desconhecido.
urlstringopcional
URL pronta para uso com os bytes do arquivo.
thumbnailUrlstringopcional
URL de uma miniatura de pré-visualização, ou null.
tagsarray of stringopcional
Tags associadas ao arquivo.
folderIdsarray of stringopcional
Pastas de arquivos às quais este arquivo pertence.
locationIdsarray of stringopcional
Todos os locais associados a este arquivo.
nextCursorstringopcional
Passe como cursor na próxima chamada para buscar a página seguinte. Null quando não há mais páginas.
countsobjectopcional
Totais por aba (all/upload/gmb/generated/discovered/ugc), independentes dos filtros ativos.
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/assets
Sua chave de API
source
type
folderId
tag
locationId
clientId
q
cursor
limit
status
{
  "data": {
    "items": [
      {
        "key": "upload:abc123",
        "source": "upload",
        "id": "abc123",
        "title": "Storefront photo",
        "filename": "storefront.jpg",
        "mime": "image/jpeg",
        "kind": "image",
        "sizeBytes": 482913,
        "url": "https://cdn.synup.com/media/abc123.jpg",
        "thumbnailUrl": "https://cdn.synup.com/media/abc123-thumb.jpg",
        "tags": [
          "VIP"
        ],
        "folderIds": [
          "folder_1"
        ],
        "locationIds": [
          "loc_456"
        ]
      }
    ],
    "nextCursor": null,
    "counts": {
      "all": 1,
      "upload": 1,
      "gmb": 0,
      "generated": 0,
      "discovered": 0,
      "ugc": 0
    }
  }
}