v1Recursos/Paid Boosts/getList boosts

List boosts

Lists the workspace's boosts, newest first: status, whether it is deferred, budget, spend so far, the post it promotes and the control that applies. Up to 50 per page.

get/api/v1/boosts
boosts:read
Parâmetros de consulta
postIdstringopcional
Only boosts of this post.
statusstringopcional
Only this status, for example awaiting_publish, active, paused, stopped, cancelled, completed, rejected or error.
activeOnlybooleanopcional
True returns only boosts that can still be stopped or cancelled.
pageintegeropcional
The page number, from 1.
limitintegeropcional
Boosts per page, 1 to 50.
Resposta
dataobjectopcional
boostsarray of objectopcional
The boosts.
totalintegeropcional
How many boosts match.
pageintegeropcional
This page's number.
perPageintegeropcional
How many boosts a page holds.
hasMorebooleanopcional
True when there is another page.
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/boosts
Sua chave de API
postId
status
activeOnly
page
limit
{
  "data": {
    "boosts": [
      {
        "adRunId": "run_123",
        "adCampaignId": "camp_123",
        "postId": "post_123",
        "platform": "facebook",
        "status": "active",
        "deferred": false,
        "control": "stop_post_boost",
        "dailyBudget": 2500,
        "durationDays": 7,
        "startAt": "2026-10-12T09:00:00.000Z",
        "endAt": "2026-10-19T09:00:00.000Z",
        "createdAt": "2026-10-12T08:55:00.000Z",
        "stoppedAt": null,
        "spend": 36.2,
        "impressions": 4210,
        "clicks": 98
      }
    ],
    "total": 1,
    "page": 1,
    "perPage": 50,
    "hasMore": false
  }
}

Novo na API da Synup?