Skip to main content
Facebook AdsVersion: v3

Get conversion pixels

GET/ad-publishing/facebook/pixels

Retrieve Facebook conversion pixels for a location. channel selects between two unrelated behaviours. For FACEBOOK (the default) the response is { items, total }, or a paginated { items, paging } envelope when limit (max 100) is given — pass after from paging.next for the next batch — and projection (comma-separated, from createdAt, fbIsCrmPixel, fbPixelCode, fbPixelId, name, type) narrows each item. For IG the response is instead a bare array of Instagram datasets carrying only an id, and limit, after, and projection are ignored.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:adPublishing.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Query Parameters

locationIdstringrequired

Location identifier

Example:loc_abc123
channelstring

Channel type

Available optionsIGFACEBOOK
Example:FACEBOOK
pageIdstring

Facebook page ID

Example:123456789
igUserIdstring

Instagram user ID

Example:ig_user_123
limitstring

Page size for a paginated fetch (max 100, FACEBOOK channel only). When set, the response is a { items, paging } envelope instead of { items, total }.

Example:25
afterstring

Opaque cursor for the next batch, taken from the previous response paging.next

Example:QVFIU...
projectionstring[]

Fields to return on each item, comma-separated (e.g. ?projection=name,fbPixelId). When set, only the requested fields are returned. Selectable fields: createdAt, fbIsCrmPixel, fbPixelCode, fbPixelId, name, type — any other value is rejected. Omit the param entirely to receive the full item as-is.

Available optionscreatedAtfbIsCrmPixelfbPixelCodefbPixelIdnametype
Example:["fbIsCrmPixel","fbPixelCode"]

Response

application/json

For channel FACEBOOK, an { items, total } object or an { items, paging } envelope when limit is given. For channel IG, a bare array of Instagram datasets, empty when no connected Instagram account matched.

oneOf
itemsobject[]required

Every pixel on the ad account

totalnumberrequired

Number of entries in items

Example:48