# List Events

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/content/management/events:
    get:
      summary: List Events
      deprecated: false
      description: ''
      tags:
        - API Reference/Management API/CMS/Events
      parameters:
        - name: status
          in: query
          description: When present, only records of given status will be returned
          required: false
          example: published
          schema:
            type: string
        - name: locale
          in: query
          description: Context of the query, used for example in [sorting](doc-341639)
          required: false
          example: en
          schema:
            type: string
        - name: publication_status
          in: query
          description: >-
            When present, only records of given publication status will be
            returned
          required: false
          example: published
          schema:
            type: string
        - name: store_id[]
          in: query
          description: ''
          required: false
          example:
            - ''
          schema:
            type: array
            items:
              type: string
        - name: excluded_publication_status
          in: query
          description: >-
            When present, only records with publication status different than
            given will be returned
          required: false
          example: expired
          schema:
            type: string
        - name: sort_by[]
          in: query
          description: ''
          required: false
          example: ends_at
          schema:
            type: string
        - name: sort_directions[]
          in: query
          description: ''
          required: false
          example: ASC
          schema:
            type: string
        - name: tag_ids[]
          in: query
          description: When present, only records having one of specified tags are returned
          required: false
          example:
            - '1'
            - '2'
          schema:
            type: array
            items:
              type: integer
        - name: category_ids[]
          in: query
          description: ''
          required: false
          example:
            - '1'
            - '2'
          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: with_archived
          in: query
          description: When true, also archived record will be treated as accessible
          example: 'false'
          schema:
            type: boolean
            default: 'false'
        - name: only_archived
          in: query
          description: When true, only archived record will be treated as accessible
          example: 'false'
          schema:
            type: boolean
            default: 'false'
        - 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-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}}'
        - name: X-Store-Id
          in: header
          description: 'Store id associated with given user role (e.g. Store Owner). '
          required: false
          example: '{{STORE_ID}}'
          schema:
            type: integer
            default: '{{STORE_ID}}'
      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/Management API/CMS/Events
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3511143-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_1
          $ref: '#/components/schemas/id'
        customer_id:
          $ref: '#/components/schemas/id.customer_id'
        locales:
          anyOf:
            - $ref: '#/components/schemas/cms.locales'
            - type: 'null'
        products:
          anyOf:
            - $ref: '#/components/schemas/cms.products'
            - type: 'null'
        status:
          $ref: '#/components/schemas/cms.status'
        visible_since:
          anyOf:
            - $ref: '#/components/schemas/cms.visible_since'
            - type: 'null'
        visible_until:
          anyOf:
            - $ref: '#/components/schemas/cms.visible_until'
            - type: 'null'
        visible_in_list:
          $ref: '#/components/schemas/cms.visible_in_list'
        sorting_priority:
          $ref: '#/components/schemas/cms.sorting_priority'
        location: &ref_0
          $ref: '#/components/schemas/LocalizedContent'
        occurrence_description:
          anyOf:
            - *ref_0
            - type: 'null'
        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. 

            In order to sort by start of the occurence, use "virtual"
            `starts_at` attribute which attempts to normalize the kinds of
            occurrence.
        group_id:
          description: '[EventsGroup](doc-341707) the record belongs to'
          anyOf:
            - *ref_1
            - type: 'null'
        store_id:
          anyOf:
            - $ref: '#/components/schemas/id.store_id'
            - type: 'null'
        title:
          anyOf:
            - *ref_0
            - type: 'null'
        slug:
          anyOf:
            - *ref_0
            - type: 'null'
        body:
          anyOf:
            - *ref_0
            - type: 'null'
        teaser:
          anyOf:
            - *ref_0
            - type: 'null'
        headline:
          anyOf:
            - *ref_0
            - type: 'null'
        image:
          description: 'Must be uploaded as a file of type: cms_event_image'
          $ref: '#/components/schemas/File'
        url:
          anyOf:
            - $ref: '#/components/schemas/cms.url'
            - type: 'null'
        publication_status:
          $ref: '#/components/schemas/cms.publication_status'
        us_legacy_data:
          type: object
          properties: {}
          x-apidog-orders: []
          x-apidog-ignore-properties: []
          nullable: true
        tag_ids:
          anyOf:
            - $ref: '#/components/schemas/tag_ids'
            - type: 'null'
        created_at:
          $ref: '#/components/schemas/date_time.created_at'
        updated_at:
          $ref: '#/components/schemas/date_time.updated_at'
        archived_at:
          $ref: '#/components/schemas/date_time.archived_at'
        category_ids:
          type: array
          items:
            type: integer
      x-apidog-orders:
        - id
        - customer_id
        - locales
        - products
        - status
        - visible_since
        - visible_until
        - visible_in_list
        - sorting_priority
        - location
        - occurrence_description
        - occurrence_type
        - occurrence
        - group_id
        - store_id
        - title
        - slug
        - body
        - teaser
        - headline
        - image
        - url
        - publication_status
        - us_legacy_data
        - tag_ids
        - created_at
        - updated_at
        - archived_at
        - category_ids
      required:
        - id
        - customer_id
        - locales
        - products
        - status
        - visible_since
        - visible_until
        - visible_in_list
        - sorting_priority
        - location
        - occurrence_description
        - occurrence_type
        - occurrence
        - group_id
        - store_id
        - title
        - slug
        - body
        - teaser
        - headline
        - image
        - url
        - publication_status
        - us_legacy_data
        - tag_ids
        - created_at
        - updated_at
        - archived_at
        - category_ids
      x-apidog-refs: {}
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    date_time.archived_at:
      type: string
      description: Time of the record archivization
      format: date-time
      examples:
        - '2022-11-15T16:25:58.099512Z'
      readOnly: true
      nullable: true
      x-apidog-folder: ''
    date_time.updated_at:
      type: string
      description: Time of the last record update
      format: date-time
      examples:
        - '2022-11-15T16:25:58.099512Z'
      readOnly: true
      x-apidog-folder: ''
    date_time.created_at:
      type: string
      description: Time of record creation
      format: date-time
      examples:
        - '2022-11-05T16:25:58.099512Z'
      readOnly: true
      x-apidog-folder: ''
    tag_ids:
      type: array
      items:
        type: integer
        minimum: 1
        examples:
          - 8216745
        title: References to tags
      description: >-
        ID of record's
        [Tags](https://api.developer.placewise.com/doc-346913.md) 
      x-apidog-folder: ''
    cms.publication_status:
      type: string
      description: >-
        Visibility status of the record in [CMS Public API](doc-341653) that
        takes into the consideration `status`, `visible_since`  and
        `visible_until` dates
      enum:
        - published
        - draft
        - expired
        - scheduled
      examples:
        - published
      readOnly: true
      x-apidog-enum:
        - value: published
          name: ''
          description: ''
        - value: draft
          name: ''
          description: ''
        - value: expired
          name: ''
          description: ''
        - value: scheduled
          name: ''
          description: ''
      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: ''
    id.store_id:
      type: integer
      description: '[Store](doc-341692) the record is assigned to'
      format: uint64
      readOnly: true
      examples:
        - 1001931
      x-apidog-folder: ''
    SingleDayEventOccurrence:
      type: object
      properties:
        day: &ref_2
          $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_2
            - type: 'null'
        end_date:
          anyOf:
            - *ref_2
            - 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_3
              $ref: '#/components/schemas/date_time'
            - type: 'null'
        ends_at:
          anyOf:
            - *ref_3
            - 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: ''
    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: ''
    cms.sorting_priority:
      type: integer
      description: >-
        Priority of the record during sorting in [CMS Public API](doc-341653).
        Currently read-only.
      examples:
        - 0
      x-apidog-folder: ''
    cms.visible_in_list:
      type: boolean
      description: Should record be returned on lists of [CMS Public API](doc-341653)
      default: true
      examples:
        - true
      x-apidog-folder: ''
    cms.visible_until:
      type: string
      description: Date until the record is visible in [CMS Public API](doc-341653)
      format: date-time
      examples:
        - '2022-11-15T16:25:58.099512Z'
      x-apidog-folder: ''
    cms.visible_since:
      type: string
      description: Date since the record is visible in [CMS Public API](doc-341653)
      format: date-time
      examples:
        - '2022-11-09T16:25:58.099512Z'
      x-apidog-folder: ''
    cms.status:
      type: string
      enum:
        - draft
        - published
        - unpublished
      examples:
        - published
      description: Determines visibility in [Public API](doc-341643)
      x-apidog-enum:
        - name: ''
          value: draft
          description: ''
        - name: ''
          value: published
          description: ''
        - name: ''
          value: unpublished
          description: ''
      x-apidog-folder: ''
    cms.products:
      type: array
      items:
        type: string
        examples:
          - test
      description: >-
        API products the record should be available to - see [X-Product-Name
        Header](doc-341635#x-locale-header)
      examples:
        - - website
      x-apidog-orders: []
      x-apidog-folder: ''
    cms.locales:
      type: array
      items:
        type: string
        examples:
          - test
      description: >-
        Locales the record should be available to - see:
        [Localization](doc-341959)
      examples:
        - - en
      x-apidog-orders: []
      x-apidog-folder: ''
    id.customer_id:
      type: integer
      format: uint64
      readOnly: true
      examples:
        - 447
      description: Customer the record is assigned to
      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: []

```