---
title: "Integrations: Retargeting Pixels API Reference | Linkbreakers"
description: "Fire your ad platforms' pixels (Meta, Google, TikTok, LinkedIn, Google Tag Manager) when someone opens one of your links or scans one of your QR codes, to…"
canonical: "https://linkbreakers.com/help/api/integrations-retargeting-pixels"
---

# Integrations: Retargeting Pixels

Fire your ad platforms' pixels (Meta, Google, TikTok, LinkedIn, Google Tag Manager) when someone opens one of your links or scans one of your QR codes, to retarget them later.

4 entries on this page

## The retargeting pixels object

RetargetingPixels.

The ad platform pixels a workspace fires on visits to its links.

`googleTagId` string

Google tag ID: a Google Analytics 4 measurement ID ("G-XXXXXXX") or a Google Ads tag ("AW-123456789").

`gtmContainerId` string

Google Tag Manager container ID ("GTM-XXXXXXX"), to fire anything else set up in that container.

`linkedinPartnerId` string

LinkedIn Insight Tag partner ID, digits only, e.g. "1234567".

`metaPixelId` string

Meta (Facebook, Instagram) Pixel ID, digits only, e.g. "123456789012345".

`scopes` array of object

One scope per pixel that is set: which links it fires on. A deleted link, directory or tag no longer appears in a selection.

5 child attributes

`directoryIds` array of string

With SELECTED\_LINKS: directories whose links, and those of every directory below them, the pixel fires on.

`linkIds` array of string

With SELECTED\_LINKS: links the pixel fires on.

`pixel` enum

The pixel this scope applies to.

Allowed values

* `RETARGETING_PIXEL_META` Meta (Facebook, Instagram) Pixel, metaPixelId.
* `RETARGETING_PIXEL_GOOGLE_TAG` Google tag (Google Analytics 4, Google Ads), googleTagId.
* `RETARGETING_PIXEL_TIKTOK` TikTok Pixel, tiktokPixelId.
* `RETARGETING_PIXEL_LINKEDIN` LinkedIn Insight Tag, linkedinPartnerId.
* `RETARGETING_PIXEL_GTM` Google Tag Manager container, gtmContainerId.

`scope` enum

ALL\_LINKS (the default) or SELECTED\_LINKS.

Allowed values

* `RETARGETING_PIXEL_SCOPE_TYPE_ALL_LINKS` Every link of the workspace, the default.
* `RETARGETING_PIXEL_SCOPE_TYPE_SELECTED_LINKS` Only the chosen links, the links of the chosen directories (and of every directory below them) and the links carrying the chosen tags.

`tagIds` array of string

With SELECTED\_LINKS: tags whose links the pixel fires on.

`tiktokPixelId` string

TikTok pixel ID, e.g. "C4ABCDEFGHIJKLMNOPQR".

`updatedAt` string (date-time)

When the pixels were last changed. Absent when none were ever set.

Example retargeting pixels

```json
{
  "googleTagId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
  "gtmContainerId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
  "linkedinPartnerId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
  "metaPixelId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
  "scopes": [
    {
      "directoryIds": [
        "string"
      ],
      "linkIds": [
        "string"
      ],
      "pixel": "RETARGETING_PIXEL_META",
      "scope": "RETARGETING_PIXEL_SCOPE_TYPE_ALL_LINKS",
      "tagIds": [
        "string"
      ]
    }
  ],
  "tiktokPixelId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
  "updatedAt": "2026-01-15T09:30:00Z"
}
```

### Response

200

`pixels` object

RetargetingPixels.

The ad platform pixels a workspace fires on visits to its links.

Fields: [The retargeting pixels object](#integrations-retargeting-pixels-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/retargeting-pixels" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Response 200

```json
{
  "pixels": {
    "googleTagId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
    "gtmContainerId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
    "linkedinPartnerId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
    "metaPixelId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
    "scopes": [
      {
        "directoryIds": [
          "string"
        ],
        "linkIds": [
          "string"
        ],
        "pixel": "RETARGETING_PIXEL_META",
        "scope": "RETARGETING_PIXEL_SCOPE_TYPE_ALL_LINKS",
        "tagIds": [
          "string"
        ]
      }
    ],
    "tiktokPixelId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
    "updatedAt": "2026-01-15T09:30:00Z"
  }
}
```

### Parameters

`linkId` string 

path

Required

The link to check.

### Response

200

`pixels` array of object

The pixels that fire on a person's visit to this link. Empty when none do, in which case the link redirects instantly.

3 child attributes

`id` string

Its ID, e.g. the Meta Pixel ID.

`pixel` enum

Which pixel.

Allowed values

* `RETARGETING_PIXEL_META` Meta (Facebook, Instagram) Pixel, metaPixelId.
* `RETARGETING_PIXEL_GOOGLE_TAG` Google tag (Google Analytics 4, Google Ads), googleTagId.
* `RETARGETING_PIXEL_TIKTOK` TikTok Pixel, tiktokPixelId.
* `RETARGETING_PIXEL_LINKEDIN` LinkedIn Insight Tag, linkedinPartnerId.
* `RETARGETING_PIXEL_GTM` Google Tag Manager container, gtmContainerId.

`scope` enum

ALL\_LINKS when it fires on every link, SELECTED\_LINKS when this link is in its selection.

Allowed values

* `RETARGETING_PIXEL_SCOPE_TYPE_ALL_LINKS` Every link of the workspace, the default.
* `RETARGETING_PIXEL_SCOPE_TYPE_SELECTED_LINKS` Only the chosen links, the links of the chosen directories (and of every directory below them) and the links carrying the chosen tags.

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/retargeting-pixels/links/{linkId}" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Response 200

```json
{
  "pixels": [
    {
      "id": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
      "pixel": "RETARGETING_PIXEL_META",
      "scope": "RETARGETING_PIXEL_SCOPE_TYPE_ALL_LINKS"
    }
  ]
}
```

### Parameters

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

`googleTagId` string

Google tag ID: "G-..." (Google Analytics 4) or "AW-..." (Google Ads).

`gtmContainerId` string

Google Tag Manager container ID, "GTM-...".

`linkedinPartnerId` string

LinkedIn Insight Tag partner ID, digits only.

`metaPixelId` string

Meta (Facebook, Instagram) Pixel ID, digits only.

`scopes` array of object

Which links pixels fire on, only for the pixels listed: a pixel left out keeps its scope. SELECTED\_LINKS needs at least one link, directory or tag of the workspace. A pixel must be set to have a scope.

5 child attributes

`directoryIds` array of string

With SELECTED\_LINKS: directories whose links, and those of every directory below them, the pixel fires on.

`linkIds` array of string

With SELECTED\_LINKS: links the pixel fires on.

`pixel` enum

The pixel this scope applies to.

Allowed values

* `RETARGETING_PIXEL_META` Meta (Facebook, Instagram) Pixel, metaPixelId.
* `RETARGETING_PIXEL_GOOGLE_TAG` Google tag (Google Analytics 4, Google Ads), googleTagId.
* `RETARGETING_PIXEL_TIKTOK` TikTok Pixel, tiktokPixelId.
* `RETARGETING_PIXEL_LINKEDIN` LinkedIn Insight Tag, linkedinPartnerId.
* `RETARGETING_PIXEL_GTM` Google Tag Manager container, gtmContainerId.

`scope` enum

ALL\_LINKS (the default) or SELECTED\_LINKS.

Allowed values

* `RETARGETING_PIXEL_SCOPE_TYPE_ALL_LINKS` Every link of the workspace, the default.
* `RETARGETING_PIXEL_SCOPE_TYPE_SELECTED_LINKS` Only the chosen links, the links of the chosen directories (and of every directory below them) and the links carrying the chosen tags.

`tagIds` array of string

With SELECTED\_LINKS: tags whose links the pixel fires on.

`tiktokPixelId` string

TikTok pixel ID.

### Response

200

`pixels` object

RetargetingPixels.

The ad platform pixels a workspace fires on visits to its links.

Fields: [The retargeting pixels object](#integrations-retargeting-pixels-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X PUT "https://api.linkbreakers.com/v1/retargeting-pixels" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "googleTagId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
  "gtmContainerId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
  "linkedinPartnerId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
  "metaPixelId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
  "scopes": [
    {
      "directoryIds": [
        "string"
      ],
      "linkIds": [
        "string"
      ],
      "pixel": "RETARGETING_PIXEL_META",
      "scope": "RETARGETING_PIXEL_SCOPE_TYPE_ALL_LINKS",
      "tagIds": [
        "string"
      ]
    }
  ],
  "tiktokPixelId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f"
}'
```

Response 200

```json
{
  "pixels": {
    "googleTagId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
    "gtmContainerId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
    "linkedinPartnerId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
    "metaPixelId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
    "scopes": [
      {
        "directoryIds": [
          "string"
        ],
        "linkIds": [
          "string"
        ],
        "pixel": "RETARGETING_PIXEL_META",
        "scope": "RETARGETING_PIXEL_SCOPE_TYPE_ALL_LINKS",
        "tagIds": [
          "string"
        ]
      }
    ],
    "tiktokPixelId": "3f6c2a5e-8b1d-4c7e-9a2f-5d8e1b0c4a7f",
    "updatedAt": "2026-01-15T09:30:00Z"
  }
}
```

---

Source: https://linkbreakers.com/help/api/integrations-retargeting-pixels
