Synupv1
Créer une clé
v1Ressources/Posts/getLister les posts

Lister les posts

Renvoie les posts d'un établissement, les plus récemment créés en premier, avec l'état de soumission par plateforme et des statistiques agrégées.

get/api/v1/posts
posts:read
Paramètres de requête
locationIdstringobligatoire
L'établissement dont lister les posts. Obligatoire.
platformstringfacultatif
Restreint les résultats aux posts soumis à cette plateforme.
typestring (announcement | event | offer)facultatif
Restreint les résultats à un type de post.
statusstringfacultatif
Restreint les résultats à un statut de post.
fromstringfacultatif
N'inclut que les posts créés à cette date ou après.
tostringfacultatif
N'inclut que les posts créés à cette date ou avant.
searchstringfacultatif
Correspondance insensible à la casse sur le nom du post.
pageintegerfacultatif
Numéro de page, à partir de 1. Par défaut 1.
perPageintegerfacultatif
Résultats par page, jusqu'à 50. Par défaut 20.
Réponse
dataobjectfacultatif
rowsarray of objectfacultatif
Les posts correspondants.
idstringfacultatif
Identifiant unique du post.
namestringfacultatif
Nom/étiquette interne du post.
typestringfacultatif
Type de post : announcement, event ou offer.
statusstringfacultatif
Statut du cycle de vie du post : draft, scheduled, active ou error.
postDatestringfacultatif
Date programmée ou de création du post, au format horodatage ISO 8601.
platformsarray of stringfacultatif
Les plateformes ciblées par ce post.
firstMediaUrlstringfacultatif
URL du premier média du post, ou null.
firstMediaTypestringfacultatif
Type du premier média du post (image ou video), ou null.
submissionsarray of objectfacultatif
État de soumission par plateforme pour ce post.
platformstringfacultatif
La plateforme concernée par cette ligne.
statusstringfacultatif
Statut de cette soumission à la plateforme : pending, active, error ou deleted.
postLinkstringfacultatif
URL publique du post publié sur cette plateforme, ou null.
reviewStatestringfacultatif
État de modération Google (processing, live, rejected), ou null pour les autres plateformes.
errorMessagestringfacultatif
Message d'erreur si cette soumission a échoué, ou null.
messagePreviewstringfacultatif
Les 140 premiers caractères de la légende du post, ou null.
viewsnumberfacultatif
Nombre total de vues, ou null si pas encore disponible.
clicksnumberfacultatif
Nombre total de clics, ou null si pas encore disponible.
errorMsgstringfacultatif
Message d'erreur de la première soumission échouée, ou null.
deletedOnstringfacultatif
Date de dépublication de ce post, au format horodatage ISO 8601, ou null.
totalnumberfacultatif
Nombre total de posts correspondants.
statsobjectfacultatif
Statistiques agrégées sur les posts correspondants.
totalPostsnumberfacultatif
Nombre de posts correspondants.
totalViewsnumberfacultatif
Total des vues sur les posts correspondants, ou null.
totalClicksnumberfacultatif
Total des clics sur les posts correspondants, ou null.
totalEngagementnumberfacultatif
Total des réactions, partages et commentaires combinés sur les posts correspondants.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
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/posts
Votre clé API
locationId *
platform
type
status
from
to
search
page
perPage
{
  "data": {
    "rows": [
      {
        "id": "cm_post_abc123",
        "name": "Fall Special Announcement",
        "type": "announcement",
        "status": "scheduled",
        "postDate": "2026-02-10T15:00:00.000Z",
        "platforms": [
          "google",
          "facebook"
        ],
        "firstMediaUrl": "https://cdn.synup.com/uploads/a1/promo.jpg",
        "firstMediaType": "image",
        "submissions": [
          {
            "platform": "google",
            "status": "pending",
            "postLink": null,
            "reviewState": null,
            "errorMessage": null
          },
          {
            "platform": "facebook",
            "status": "pending",
            "postLink": null,
            "reviewState": null,
            "errorMessage": null
          }
        ],
        "messagePreview": "Join us this weekend for our fall special — 20% off all services!",
        "views": null,
        "clicks": null,
        "errorMsg": null,
        "deletedOn": null
      }
    ],
    "total": 1,
    "stats": {
      "totalPosts": 12,
      "totalViews": 4300,
      "totalClicks": 210,
      "totalEngagement": 96
    }
  }
}