---
updatedAt: 2025-06-04T21:28:26.000Z
agentTools:
  projectIndex: https://developer.simpplr.com/llms.txt
---

# Get Carousel data

Use this API to retrieve Carousels in the Home page, a particular Site or Segment.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "simpplr-api-gateway",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.ec.simpplr.com/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/carousels/{type}": {
      "get": {
        "summary": "Get Carousel data",
        "description": "Use this API to retrieve Carousels in the Home page, a particular Site or Segment.",
        "operationId": "get-carousel-data",
        "parameters": [
          {
            "name": "type",
            "in": "path",
            "description": "Type of the Carousel to search for",
            "schema": {
              "type": "string",
              "enum": [
                "Home",
                "Site",
                "Segment"
              ],
              "default": "Home"
            },
            "required": true
          },
          {
            "name": "site-id",
            "in": "query",
            "description": "ID of the Site from which the Carousels should be fetched (REQUIRED if type is set as Site)",
            "schema": {
              "type": "string",
              "default": "a1A5e000001wQdXEAU"
            }
          },
          {
            "name": "segment-id",
            "in": "query",
            "description": "ID of the Segment from which the Carousels should be fetched. REQUIRED if type is set to Segment. Note: Works only if Segmentation is enabled for your org.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "x-user-email",
            "in": "header",
            "description": "User's email to login into Salesforce",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"statusCode\": 200,\n    \"status\": \"success\",\n    \"message\": \"\",\n    \"data\": {\n        \"siteId\": \"a1A5e000001wQdXEAU\",\n        \"layout\": \"showcase\",\n        \"listOfItems\": []\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "statusCode": {
                      "type": "integer",
                      "example": 200,
                      "default": 0
                    },
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "message": {
                      "type": "string",
                      "example": ""
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "siteId": {
                          "type": "string",
                          "example": "a1A5e000001wQdXEAU"
                        },
                        "layout": {
                          "type": "string",
                          "example": "showcase"
                        },
                        "listOfItems": {
                          "type": "array"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```