---
agentTools:
  projectIndex: https://developers.uberflip.com/llms.txt
---

# List CTA Placements

List all CTA Placements

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Uberflip API",
    "version": "2.1",
    "description": "Uberflip API",
    "contact": {
      "name": "Uberflip",
      "url": "https://developers.uberflip.com/",
      "email": "contact@uberflip.com"
    }
  },
  "servers": [
    {
      "url": "https://v2.api.uberflip.com"
    }
  ],
  "tags": [
    {
      "name": "CTAS"
    },
    {
      "name": "CTA PLACEMENTS"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/cta-placements": {
      "get": {
        "tags": [
          "CTA PLACEMENTS",
          "CTAS"
        ],
        "summary": "List CTA Placements",
        "operationId": "list-cta-placements",
        "description": "List all CTA Placements",
        "parameters": [
          {
            "name": "cta_id",
            "in": "query",
            "description": "Call to Action ID",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "Specify the field that should be used to sort the returned CTA Placements. See the table below for accepted `sort` values. Sort order will be ascending.\n- `id`: Sort by CTA Placement identifier code\n- `stream_name`: Sort by Stream name\n",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/limitParam"
          },
          {
            "$ref": "#/components/parameters/pageParam"
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "description": "The collection of CTA Placements",
                      "items": {
                        "$ref": "#/components/schemas/cta-placement"
                      }
                    },
                    "meta": {
                      "type": "object",
                      "description": "See: Pagination"
                    }
                  }
                },
                "examples": {
                  "Result": {
                    "value": {
                      "data": [
                        {
                          "id": 123456,
                          "cta_id": 289194,
                          "stream_id": 1596327,
                          "position": 5,
                          "position_active": false,
                          "item_level": 0,
                          "item_block_initial_delay": null,
                          "item_block_optional": false,
                          "item_block_repeat_delay": null,
                          "item_block_select_items": false,
                          "item_block_item_count": null,
                          "repeat_after": 10,
                          "repeat_after_active": false,
                          "item_show_body": true
                        }
                      ],
                      "meta": {
                        "count": 1,
                        "limit": 25,
                        "total_pages": 1
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Access token from /authorize endpoint"
      }
    },
    "parameters": {
      "limitParam": {
        "name": "limit",
        "in": "query",
        "description": "Set the number of results returned per [page](https://developers.uberflip.com/reference/pagination). Defaults to 25 if not set.",
        "schema": {
          "type": "integer",
          "default": 25,
          "minimum": 1,
          "maximum": 100
        }
      },
      "pageParam": {
        "name": "page",
        "in": "query",
        "description": "Specify the [page](https://developers.uberflip.com/reference/pagination) of results to be returned. Defaults to 1 if not set.",
        "schema": {
          "type": "integer",
          "default": 1,
          "minimum": 1
        }
      }
    },
    "schemas": {
      "cta-placement": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The CTA Placement identifier"
          },
          "cta_id": {
            "type": "integer",
            "description": "The CTA identifier"
          },
          "stream_id": {
            "type": "integer",
            "description": "The Stream identifier"
          },
          "position": {
            "type": "integer",
            "description": "The number of Items after which the CTA Placement will be positioned"
          },
          "position_active": {
            "type": "boolean",
            "description": "Whether the CTA Placement is displayed or not"
          },
          "repeat_after": {
            "type": "integer",
            "description": "The number of Items after which the CTA Placement will be repeated"
          },
          "repeat_after_active": {
            "type": "boolean",
            "description": "Whether the CTA Placement is repeated or not"
          },
          "item_level": {
            "type": "integer",
            "description": "The placement of the CTA on the Item pages (0 = hide, 1 = show beside, 2 = block)"
          },
          "item_block_initial_delay": {
            "type": "integer",
            "description": "The number of seconds to wait before blocking the Item with the CTA",
            "nullable": true
          },
          "item_block_optional": {
            "type": "boolean",
            "description": "Whether the CTA can be dismissed or not"
          },
          "item_block_repeat_delay": {
            "type": "integer",
            "description": "The number of seconds to wait before re-displaying a dismissed CTA",
            "nullable": true
          },
          "item_block_select_items": {
            "type": "boolean",
            "description": "Whether the CTA should block only selected items"
          },
          "item_block_item_count": {
            "type": "integer",
            "description": "The number of Items blocked by the CTA if item_block_select_items is true",
            "nullable": true
          },
          "item_show_body": {
            "type": "boolean",
            "description": "Whether the CTA will block only the video/document or not (only applicable to Video, Docs and Marketing Streams)"
          },
          "stream_name": {
            "type": "string",
            "description": "The name of the Stream where the CTA is placed"
          },
          "stream_type": {
            "type": "string",
            "description": "The type of the Stream where the CTA is placed"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 99,
      "1": 151,
      "2": 113,
      "3": 115,
      "4": 165,
      "5": 253,
      "6": 73,
      "7": 0,
      "8": 113,
      "9": 158,
      "10": 39,
      "11": 103
    }
  }
}
```