# List Events

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/content/events:
    get:
      summary: List Events
      deprecated: false
      description: ''
      tags:
        - API Reference/Public API/CMS Content/Events
      parameters:
        - name: store_ids
          in: query
          description: When present, returns only events from given stores
          required: false
          example: ''
          schema:
            type: array
            items:
              type: integer
        - name: per_page
          in: query
          description: >-
            Number of results to be returned per request. See: [API
            Pagination](doc-341638)
          example: 10
          schema:
            type: integer
            default: '10'
        - name: page_no
          in: query
          description: 'Number of results page. See: [API Pagination](doc-341638)'
          example: 1
          schema:
            type: integer
            minimum: 1
            default: '1'
        - name: sort_by[]
          in: query
          description: 'See: [Sorting params](doc-341639)'
          example: id
          schema:
            type: string
            default: id
        - name: sort_directions[]
          in: query
          description: 'See: [Sorting params](doc-341639)'
          example: DESC
          schema:
            type: string
            enum:
              - ASC
              - DESC
            examples:
              - ASC
              - DESC
            default: DESC
            x-apidog-enum:
              - value: ASC
                name: ''
                description: ''
              - value: DESC
                name: ''
                description: ''
        - name: Content-Type
          in: header
          description: '[Details](doc-341635)'
          required: true
          example: application/json
          schema:
            type: string
            default: application/json
            const: application/json
        - name: X-User-Agent
          in: header
          description: Arbitrary identifier of your client. [Details](doc-341635)
          required: true
          example: '{{X_USER_AGENT}}'
          schema:
            type: string
            default: '{{X_USER_AGENT}}'
        - name: X-Product-Name
          in: header
          description: API Product for API context. [Details](doc-341635)
          required: true
          example: '{{PRODUCT_NAME}}'
          schema:
            type: string
            default: '{{PRODUCT_NAME}}'
        - name: X-Loyalty-Club-Slug
          in: header
          description: LoyaltyClub for API context. [Details](doc-342138)
          required: false
          example: '{{LOYALTY_CLUB_SLUG}}'
          schema:
            type: string
            default: '{{LOYALTY_CLUB_SLUG}}'
        - name: X-Customer
          in: header
          description: Customer for API context.  [Details](doc-342139)
          required: false
          example: '{{CUSTOMER_ID}}'
          schema:
            type: string
            default: '{{CUSTOMER_ID}}'
        - name: Authorization
          in: header
          description: '[Member](doc-342129) or [User](doc-342130) Authorization.'
          required: false
          example: Bearer {{_OAUTH_TOKEN}}
          schema:
            type: string
            default: Bearer {{_OAUTH_TOKEN}}
        - name: X-Client-Authorization
          in: header
          description: '[Token](doc-342128) Authorization.'
          example: '{{API_TOKEN}}'
          schema:
            type: string
            default: '{{API_TOKEN}}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  events:
                    type: array
                    items:
                      $ref: '#/components/schemas/Event'
                  pagination_info:
                    $ref: '#/components/schemas/PaginationInfo'
                x-apidog-orders:
                  - events
                  - pagination_info
                required:
                  - events
                  - pagination_info
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: API Reference/Public API/CMS Content/Events
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3510891-run
components:
  schemas:
    PaginationInfo:
      type: object
      properties:
        count:
          type: integer
          description: Actual number of results returned in request
          readOnly: true
          examples:
            - 1000
        total_count:
          type: integer
          description: Number of all available results
          minimum: 1
          examples:
            - 2050
        per_page:
          type: integer
          description: Number of results returned per request
          readOnly: true
          examples:
            - 1000
        total_pages:
          type: integer
          description: Number of all available pages
          readOnly: true
          examples:
            - 3
        current_page:
          type: integer
          readOnly: true
          examples:
            - 1
        next_page:
          type: integer
          description: Next available page (null when it's a last page)
          readOnly: true
          examples:
            - 2
          nullable: true
        prev_page:
          type: integer
          description: Next available page (null when it's a first page)
          readOnly: true
          examples:
            - null
          nullable: true
        is_first_page:
          type: boolean
          readOnly: true
          examples:
            - true
        is_last_page:
          type: boolean
          readOnly: true
          examples:
            - false
        is_out_of_range:
          type: boolean
          description: Is given `per_page` param out of range?
          readOnly: true
          examples:
            - false
        offset:
          type: integer
          readOnly: true
          examples:
            - 0
      required:
        - count
        - total_count
        - per_page
        - total_pages
        - current_page
        - next_page
        - prev_page
        - is_first_page
        - is_last_page
        - is_out_of_range
        - offset
      x-apidog-orders:
        - count
        - total_count
        - per_page
        - total_pages
        - current_page
        - next_page
        - prev_page
        - is_first_page
        - is_last_page
        - is_out_of_range
        - offset
      readOnly: true
      x-apidog-ignore-properties: []
      nullable: true
      x-apidog-folder: ''
    Event:
      type: object
      properties:
        id: &ref_0
          $ref: '#/components/schemas/id'
        group_id:
          description: ID of [Events Group](doc-341658) the record belongs to
          anyOf:
            - *ref_0
            - type: 'null'
        store_id:
          anyOf:
            - $ref: '#/components/schemas/id.store_id'
            - type: 'null'
          description: ID of [Store](doc-341663) the record belongs to
        title: &ref_1
          description: '[Localized](doc-341959)'
          $ref: '#/components/schemas/LocalizedContent'
        slug:
          description: '[Localized](doc-341959)'
          anyOf:
            - *ref_1
            - type: 'null'
        teaser:
          type: string
          readOnly: true
          description: '[Localized](doc-341959)'
          examples:
            - Teaser
          nullable: true
        body:
          description: '[Localized](doc-341959)'
          anyOf:
            - *ref_1
            - type: 'null'
        headline:
          readOnly: true
          type: string
          description: '[Localized](doc-341959)'
          examples:
            - Headline
          nullable: true
        location:
          readOnly: true
          type: string
          description: '[Localized](doc-341959)'
          examples:
            - Location
          nullable: true
        image:
          $ref: '#/components/schemas/File'
        url:
          anyOf:
            - $ref: '#/components/schemas/cms.url'
            - type: 'null'
        starts_at:
          anyOf:
            - &ref_2
              $ref: '#/components/schemas/date_time'
            - type: 'null'
          deprecated: true
          description: >-
            Informs when the Event starts. Deprecated in favor of
            `occurrence.starts_at`
        ends_at:
          anyOf:
            - *ref_2
            - type: 'null'
          deprecated: true
          description: >-
            Informs when the Event ends. Deprecated in favor of
            `occurrence.ends_at`
        date_text:
          type: string
          description: >-
            Additional arbitrary information about occurrence of the Event.
            Deprecated in favor of `occurrence_description`.
            [Localized](doc-341959)
          deprecated: true
          nullable: true
        occurrence_description:
          type: string
          nullable: true
        occurrence_type:
          type: string
          description: Determines type of `ocurrence`
          enum:
            - time_range
            - date_range
            - single_day
          default: time_range
          examples:
            - time_range
          x-apidog-enum:
            - name: ''
              value: time_range
              description: ''
            - name: ''
              value: date_range
              description: ''
            - name: ''
              value: single_day
              description: ''
        occurrence:
          anyOf:
            - $ref: '#/components/schemas/TimeRangeEventOccurrence'
            - $ref: '#/components/schemas/DateRangeEventOccurrence'
            - $ref: '#/components/schemas/SingleDayEventOccurrence'
          description: Informs when the Event occurs
        category_ids:
          type: array
          items:
            type: integer
      x-apidog-orders:
        - id
        - group_id
        - store_id
        - title
        - slug
        - teaser
        - body
        - headline
        - location
        - image
        - url
        - starts_at
        - ends_at
        - date_text
        - occurrence_description
        - occurrence_type
        - occurrence
        - category_ids
      required:
        - id
        - group_id
        - store_id
        - title
        - slug
        - teaser
        - body
        - headline
        - image
        - url
        - starts_at
        - ends_at
        - date_text
        - occurrence_description
        - occurrence_type
        - occurrence
        - category_ids
      readOnly: true
      x-apidog-refs: {}
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    SingleDayEventOccurrence:
      type: object
      properties:
        day: &ref_3
          $ref: '#/components/schemas/date'
      x-apidog-orders:
        - day
      required:
        - day
      description: >-
        For `occurrence_type = "single_day". Defines occurrence as a whole
        specific day
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    date:
      type: string
      format: date
      examples:
        - '2023-01-15'
      x-apidog-folder: ''
    DateRangeEventOccurrence:
      type: object
      properties:
        start_date:
          anyOf:
            - *ref_3
            - type: 'null'
        end_date:
          anyOf:
            - *ref_3
            - type: 'null'
      x-apidog-orders:
        - start_date
        - end_date
      required:
        - start_date
        - end_date
      description: >-
        For `occurrence_type = "date_range". Defines occurrence as a range
        starting on specific day and ending on other specific day
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    TimeRangeEventOccurrence:
      type: object
      properties:
        starts_at:
          anyOf:
            - *ref_2
            - type: 'null'
        ends_at:
          anyOf:
            - *ref_2
            - type: 'null'
      x-apidog-orders:
        - starts_at
        - ends_at
      required:
        - starts_at
        - ends_at
      description: >-
        For `occurrence_type = "date_range". Defines occurrence as a range
        starting on specific time and ending on other specific time
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    date_time:
      type: string
      format: date-time
      examples:
        - '2022-11-09T16:25:58.099512Z'
      x-apidog-folder: ''
    cms.url:
      type: string
      description: Address of the entity page on website
      examples:
        - path/to/:id
      readOnly: true
      x-apidog-folder: ''
    File:
      type: object
      properties:
        url:
          type: string
          format: uri
          readOnly: true
          examples:
            - https://example.com/image.png
        identifier:
          type: string
          description: Only present when parent record has many files
          examples:
            - '1'
        mime_type:
          type: string
          examples:
            - image/jpeg
          readOnly: true
          description: Only present in certain circumstances
          nullable: true
        created_at:
          type: string
          format: date-time
          examples:
            - '2022-11-09T15:46:00.252860Z'
        updated_at:
          type: string
          format: date-time
          readOnly: true
          examples:
            - '2022-11-09T15:46:00.252860Z'
        image_details:
          type: object
          properties:
            width:
              type: integer
              minimum: 1
            height:
              type: integer
              minimum: 1
          x-apidog-orders:
            - width
            - height
          x-apidog-ignore-properties: []
          nullable: true
      x-apidog-orders:
        - url
        - identifier
        - mime_type
        - created_at
        - updated_at
        - image_details
      required:
        - url
        - created_at
        - updated_at
      readOnly: true
      x-apidog-ignore-properties: []
      nullable: true
      x-apidog-folder: ''
    LocalizedContent:
      type: object
      properties: {}
      x-apidog-orders: []
      title: ''
      examples:
        - en: Text
      additionalProperties:
        type: string
        description: >-
          The actual set of languages depends on LC configuration. See:
          [Localization](doc-341959)
        examples:
          - Tekst
        nullable: true
      x-apidog-ignore-properties: []
      nullable: true
      x-apidog-folder: ''
    id.store_id:
      type: integer
      description: '[Store](doc-341692) the record is assigned to'
      format: uint64
      readOnly: true
      examples:
        - 1001931
      x-apidog-folder: ''
    id:
      type: integer
      description: Primary identifier of the record
      format: uint64
      readOnly: true
      examples:
        - 1
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```