v1Recursos/Post Ideas/getListar ideias de publicação

Listar ideias de publicação

Retorna ideias de publicação em um de três modos: passe locationId para a grade paginada de um único local; passe clientId com scope=locations para o resumo das ideias em nível de local em todos os locais de um cliente; ou passe clientId com scope=brand para as ideias em nível de marca desse cliente.

get/api/v1/post-ideas

ideas:read

Parâmetros de consulta

locationIdstringopcional

Lista ideias para este local (modo paginado).

clientIdstringopcional

Lista ideias para este cliente. Requer scope.

scopestring (locations | brand)opcional

Qual conjunto de ideias em nível de cliente retornar: locations (resumo dos locais do cliente) ou brand (ideias em nível de marca).

bucketstring (idea | holiday | calendar | series)opcional

Restringe os resultados a um bucket (somente no modo locationId).

statusstringopcional

Restringe os resultados a um status, ou "archived" para listar ideias arquivadas em vez disso (somente no modo locationId).

seriesIdstringopcional

Restringe os resultados a ideias nesta série de conteúdo (somente no modo locationId).

searchstringopcional

Correspondência sem diferenciar maiúsculas/minúsculas com o título da ideia (somente no modo locationId).

pageintegeropcional

Número da página, começando em 1. O padrão é 1 (somente no modo locationId).

perPageintegeropcional

Resultados por página, até 50. O padrão é 20 (somente no modo locationId).

includeRejectedbooleanopcional

Inclui ideias rejeitadas durante a aprovação. O padrão é false (somente nos modos clientId).

Resposta

dataobjectopcional

Erros

400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.

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

Sua chave de 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
        }
      }
    ]
  }
}