openapi: 3.2.0
info:
  title: simpplr-api-gateway Carousels API
  version: '1.0'
servers:
- url: https://api.ec.simpplr.com/api
security:
- sec0: []
tags:
- name: Carousels
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
      tags:
      - Carousels
components:
  securitySchemes:
    sec0:
      type: oauth2
      flows: {}
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://developer.simpplr.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.simpplr.com/reference/add-a-follower-to-a-site.md
  - https://developer.simpplr.com/reference/add-a-member-to-a-site.md
  - https://developer.simpplr.com/reference/add-audience.md
  - https://developer.simpplr.com/reference/app-adoption-1.md
  - https://developer.simpplr.com/reference/app-adoption-average.md
  - https://developer.simpplr.com/reference/app-adoption.md
  - https://developer.simpplr.com/reference/app-page-views.md
  - https://developer.simpplr.com/reference/autocomplete.md
  - https://developer.simpplr.com/reference/campaigns.md
  - https://developer.simpplr.com/reference/content-engagement.md
  - https://developer.simpplr.com/reference/content-publications.md
  - https://developer.simpplr.com/reference/content-referral-sources.md
  - https://developer.simpplr.com/reference/content-views-by-type.md
  - https://developer.simpplr.com/reference/content-views-list.md
  - https://developer.simpplr.com/reference/create-a-blog.md
  - https://developer.simpplr.com/reference/create-a-new-alert.md
  - https://developer.simpplr.com/reference/create-a-notification.md
  - https://developer.simpplr.com/reference/create-a-site.md
  - https://developer.simpplr.com/reference/create-an-event.md
  - https://developer.simpplr.com/reference/delete-a-blog.md
  - https://developer.simpplr.com/reference/delete-a-page-by-id.md
  - https://developer.simpplr.com/reference/delete-album-images-by-ids.md
  - https://developer.simpplr.com/reference/delete-an-alert.md
  - https://developer.simpplr.com/reference/delete-an-event-by-id.md
  - https://developer.simpplr.com/reference/delete-audience.md
  - https://developer.simpplr.com/reference/expire-an-alert.md
  - https://developer.simpplr.com/reference/get-all-events.md
  - https://developer.simpplr.com/reference/get-blog-by-id.md
  - https://developer.simpplr.com/reference/get-carousel-data.md
  - https://developer.simpplr.com/reference/get-must-read-content.md
  - https://developer.simpplr.com/reference/get-site-by-id.md
  - https://developer.simpplr.com/reference/knowledge-page-stats.md
  - https://developer.simpplr.com/reference/low-activity-sites.md
  - https://developer.simpplr.com/reference/news-letters.md
  - https://developer.simpplr.com/reference/people-count.md
  - https://developer.simpplr.com/reference/people-performance.md
  - https://developer.simpplr.com/reference/people-profile-completeness.md
  - https://developer.simpplr.com/reference/remove-a-follower-from-a-site.md
  - https://developer.simpplr.com/reference/remove-a-member-from-a-site.md
  - https://developer.simpplr.com/reference/search-for-a-page-by-id.md
  - https://developer.simpplr.com/reference/search-for-alerts.md
  - https://developer.simpplr.com/reference/search-for-an-event-by-id.md
  - https://developer.simpplr.com/reference/search-for-contents.md
  - https://developer.simpplr.com/reference/search-for-notifications.md
  - https://developer.simpplr.com/reference/search-for-people.md
  - https://developer.simpplr.com/reference/search-for-site-by-id.md
  - https://developer.simpplr.com/reference/search-for-sites.md
  - https://developer.simpplr.com/reference/search-list-1.md
  - https://developer.simpplr.com/reference/search-list.md
  - https://developer.simpplr.com/reference/search-page-categories.md
  - https://developer.simpplr.com/reference/search-within-a-section.md
  - https://developer.simpplr.com/reference/search-within-feed.md
  - https://developer.simpplr.com/reference/searches.md
  - https://developer.simpplr.com/reference/site-count.md
  - https://developer.simpplr.com/reference/site-popularity.md
  - https://developer.simpplr.com/reference/site-publications.md
  - https://developer.simpplr.com/reference/social-engagement-list.md
  - https://developer.simpplr.com/reference/social-engagement.md
  - https://developer.simpplr.com/reference/update-a-blog.md
  - https://developer.simpplr.com/reference/update-a-notification.md
  - https://developer.simpplr.com/reference/update-a-page.md
  - https://developer.simpplr.com/reference/update-a-site.md
  - https://developer.simpplr.com/reference/update-an-alert.md
  - https://developer.simpplr.com/reference/update-an-event.md
  - https://developer.simpplr.com/reference/update-audience.md
  - https://developer.simpplr.com/reference/update-people.md
  - https://developer.simpplr.com/reference/update-site-as-active.md
  merge:
    pages: 67
    deduped: 66
    conflicts_kept_first: 0