API referenceAds

GET /api/v1/ads/accounts

Ad accounts the connected Facebook user can reach (needs ads_read or ads_management on the account). Only those linked to the Page (owned by its business, that promoted it, or allowed by a person) can be used: others answer 403 ad_account_not_linked. currencyOffset 100: amounts in cents; 1: whole units. Mock mode returns three sandbox accounts (USD, EUR, CLP)

GET
/api/v1/ads/accounts

Authorization

BearerAuth
headerAuthorizationBearer <token>

API key sk_...

Query Parameters

accountId*string

Connected Facebook Page account id

after?string

next of the previous page

Response Body

{adAccounts, next, mock}

application/json
  1. response
adAccounts?array<>
next?string|null
mock?boolean
Example Request
curl -X GET 'https://example.com/api/v1/ads/accounts?accountId=string'
Example Response
{  "adAccounts": [    {      "id": "string",      "account_id": "string",      "name": "string",      "currency": "string",      "currencyOffset": 1,      "account_status": 0,      "timezone_name": "string"    }  ],  "next": "string",  "mock": true}

GET /api/v1/x/accounts/{id}/users/{username} GET

One X user by @username: id, name, subscriptionType, verified, followers, receivesYourDm

POST /api/v1/ads/boost POST

Boost a published Facebook Page or Instagram post: creates campaign, ad set, creative (referencing the post, keeping its likes and comments) and ad, PAUSED unless status ACTIVE. Requires confirm: true