v1Ressources/Idées de post/getLister les idées de post

Lister les idées de post

Renvoie des idées de post selon l'un des trois modes suivants : passez locationId pour la grille (paginée) d'un seul établissement ; passez clientId avec scope=locations pour la synthèse des idées au niveau des établissements sur l'ensemble des établissements d'un client ; ou passez clientId avec scope=brand pour les idées de niveau marque de ce client.

get/api/v1/post-ideas

ideas:read

Paramètres de requête

locationIdstringfacultatif

Lister les idées de cet établissement (mode paginé).

clientIdstringfacultatif

Lister les idées de ce client. Nécessite scope.

scopestring (locations | brand)facultatif

Quel ensemble d'idées de niveau client renvoyer : locations (synthèse sur les établissements du client) ou brand (idées de niveau marque).

bucketstring (idea | holiday | calendar | series)facultatif

Restreint les résultats à une seule catégorie (mode locationId uniquement).

statusstringfacultatif

Restreint les résultats à un seul statut, ou "archived" pour lister les idées archivées à la place (mode locationId uniquement).

seriesIdstringfacultatif

Restreint les résultats aux idées de cette série de contenu (mode locationId uniquement).

searchstringfacultatif

Correspondance insensible à la casse sur le titre de l'idée (mode locationId uniquement).

pageintegerfacultatif

Numéro de page, à partir de 1. Par défaut 1 (mode locationId uniquement).

perPageintegerfacultatif

Résultats par page, jusqu'à 50. Par défaut 20 (mode locationId uniquement).

includeRejectedbooleanfacultatif

Inclut les idées rejetées lors de la validation. Par défaut false (modes clientId uniquement).

Réponse

dataobjectfacultatif

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/post-ideas

Votre clé API

locationId

clientId

scope

bucket

status

seriesId

search

page

perPage

includeRejected

{
  "data": {
    "rows": [
      {
        "id": "cm_idea_abc123",
        "agencyId": "cm_agency_1",
        "locationId": "cm_loc_1",
        "clientLocationId": "cm_loc_1",
        "clientId": null,
        "brandName": null,
        "agentMeta": null,
        "title": "Spotlight our new patient special",
        "content": "Book this month and get 20% off your first cleaning!",
        "imagePrompt": null,
        "imageUrl": null,
        "type": "announcement",
        "status": "draft",
        "bucket": "idea",
        "platforms": [
          "google",
          "facebook"
        ],
        "seriesId": null,
        "scheduledDate": null,
        "scheduledTime": null,
        "observanceName": null,
        "observanceDate": null,
        "generationBatchId": null,
        "generationJobId": null,
        "isUserGenerated": true,
        "source": "os",
        "externalId": "cm_idea_abc123",
        "reviewStatus": null,
        "archived": false,
        "archivedAt": null,
        "createdAt": "2026-01-20T09:00:00.000Z",
        "updatedAt": "2026-01-20T09:00:00.000Z"
      }
    ],
    "total": 1,
    "page": 1,
    "perPage": 20,
    "counts": [
      {
        "bucket": "idea",
        "_count": {
          "id": 4
        }
      }
    ]
  }
}