Synupv1
Créer une clé
v1Ressources/Données/getLister les assets

Lister les assets

Renvoie un extrait paginé du catalogue d'assets unifié, du plus récent au plus ancien — téléversements, images générées par IA, assets de la bibliothèque de médias synchronisée, photos importées de GBP et médias soumis par les utilisateurs (UGC), fusionnés en un seul flux.

get/api/v1/assets
media:read
Paramètres de requête
sourcestring (all | upload | gmb | generated | discovered | ugc)facultatif
Limiter à un onglet source : all (par défaut), upload, gmb, generated, discovered ou ugc.
typestringfacultatif
Limiter à un type d'asset, p. ex. image ou video.
folderIdstringfacultatif
Limiter aux assets de ce dossier.
tagstringfacultatif
Limiter aux assets portant cette étiquette.
locationIdstringfacultatif
Limiter aux assets assignés à cet établissement. Retrouvez-le avec GET /api/v1/locations.
clientIdstringfacultatif
Le client auquel limiter les résultats. Obligatoire si cette clé est restreinte à des clients spécifiques et qu'aucun locationId n'est indiqué. Retrouvez-le avec GET /api/v1/clients.
qstringfacultatif
Rechercher par titre ou nom de fichier.
cursorstringfacultatif
Curseur de pagination provenant du nextCursor d'une réponse précédente.
limitnumberfacultatif
Nombre maximal d'éléments à renvoyer. 60 par défaut, 200 maximum.
statusstring (needs_review | spam | ok | skipped)facultatif
Filtre de statut de modération — s'applique uniquement quand source vaut ugc : needs_review, spam, ok ou skipped.
Réponse
dataobjectfacultatif
itemsarray of objectfacultatif
La page d'assets.
keystringfacultatif
Identifiant composite du fichier, au format « <source>:<id> ».
sourcestringfacultatif
Origine de ce fichier (par ex. un envoi OS par rapport à une source importée).
idstringfacultatif
L'id du fichier au sein de sa source.
titlestringfacultatif
Le titre du fichier.
filenamestringfacultatif
Le nom de fichier d'origine du fichier.
mimestringfacultatif
Le type MIME du fichier.
kindstringfacultatif
Le type du fichier (photo ou vidéo).
sizeBytesnumberfacultatif
Taille du fichier en octets, ou null si inconnue.
urlstringfacultatif
URL prête à l'emploi pour les octets du fichier.
thumbnailUrlstringfacultatif
URL d'un aperçu miniature, ou null.
tagsarray of stringfacultatif
Étiquettes associées au fichier.
folderIdsarray of stringfacultatif
Dossiers de fichiers auxquels ce fichier appartient.
locationIdsarray of stringfacultatif
Tous les établissements auxquels ce fichier est associé.
nextCursorstringfacultatif
À passer en tant que cursor lors du prochain appel pour récupérer la page suivante. Null s'il n'y en a pas d'autre.
countsobjectfacultatif
Totaux par onglet (all/upload/gmb/generated/discovered/ugc), indépendants des filtres actifs.
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/assets
Votre clé 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
    }
  }
}