> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fourvenues.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get all events

> Get all events



## OpenAPI

````yaml get /events
openapi: 3.0.0
info:
  title: Channel Manager API
  version: 0.1.0
  description: >-
    Official API documentation for Channel Manager. All endpoints are protected
    by an API key.
servers:
  - url: https://channels-service-alpha.fourvenues.com
    description: Test server
  - url: https://channels-service.fourvenues.com
    description: Production server
security: []
tags: []
paths:
  /events:
    get:
      tags:
        - Events
      summary: Get all events
      description: Get all events
      operationId: getEvents
      parameters:
        - name: organization_id
          in: query
          description: Filter the events by organization id.
          required: false
          schema:
            type: string
        - name: start_date
          in: query
          description: Filter the events by start date.
          required: false
          schema:
            type: string
            format: iso
        - name: end_date
          in: query
          description: Filter the events by end date.
          required: false
          schema:
            type: string
            format: iso
        - name: populate
          in: query
          description: >-
            Populates the events with additional options separated by comma.


            Default response already includes location, artists, preregister
            status (`is_preregistered`) and preregister configuration
            (`preregister`).


            Populate options:

            - `*`: All populators

            - `ticket-rates`: Ticket Rates

            - `list-rates`: List Rates

            - `event-groups`: Event Groups

            - `preregister`: Preregister status and configuration
          required: false
          schema:
            type: string
        - name: search
          in: query
          description: >-
            Each word in search must be in the events name to return it. Example
            if an event name is 'Fourvenues New Disco' and we search for
            'fourven disc' the event should be returned.
          required: false
          schema:
            type: string
        - name: location_id
          in: query
          description: Filter the events by location id.
          required: false
          schema:
            type: string
        - name: lat
          in: query
          description: >-
            Filter by zone radius. Latitude of the center radius. This field is
            required if lng or radius are pass.
          required: false
          schema:
            type: number
        - name: lng
          in: query
          description: >-
            Filter by zone radius. Longitude of the center radius. This field is
            required if lat or radius are pass
          required: false
          schema:
            type: number
        - name: radius
          in: query
          description: >-
            Filter by zone radius. Radius of the zone to search in kilometers
            (Max 500). This field is required if lng or lat are pass
          required: false
          schema:
            type: number
        - name: limit
          in: query
          description: Limit the number of events returned.
          required: false
          schema:
            type: integer
            format: int32
            default: '50'
        - name: offset
          in: query
          description: Offset the events returned.
          required: false
          schema:
            type: integer
            format: int32
            default: '0'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Event'
                  success:
                    type: boolean
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
      security:
        - ApiKey: []
components:
  schemas:
    Event:
      type: object
      properties:
        _id:
          type: string
          example: abcdefghi1234567890
          description: Unique identifier of the event.
        name:
          type: string
          example: Monday Night
          description: Name of the event.
        slug:
          type: string
          example: monday-night
          description: Slug of the event.
        description:
          type: string
          example: Lorem ipsum
          description: Description of the event.
        display_date:
          type: string
          format: date-time
          example: '2023-12-31T00:00:00.000Z'
          description: Date that should be displayed as the date of the event.
        start_date:
          type: string
          format: date-time
          example: '2024-01-01T00:00:00.000Z'
          description: Legal start date of the event.
        end_date:
          type: string
          format: date-time
          example: '2024-01-01T06:00:00.000Z'
          description: Legal end date of the event.
        organization_id:
          type: string
          example: abcdefghi1234567890
          description: Unique identifier for the organization.
        age:
          type: number
          example: '18'
          description: Minimum age.
        image_url:
          type: string
          example: https://somecdn.com/random-hash
          description: Flyer of the event.
        outfit:
          type: string
          example: casual
          description: Dresscode of the event.
          enum:
            - free
            - casual
            - formal
            - black-tie
            - smart
        ambiences:
          type: array
          items:
            type: string
            example: alternative
            description: Ambience of the event.
            enum:
              - lgtbiqplus
              - alternative
              - erasmus
              - international
              - underground
              - university
              - urban
              - young
        music_genres:
          type: array
          items:
            type: string
            example: bachata
            description: Music genre of the event.
            enum:
              - chill
              - house
              - bachata
              - trance
              - classical
              - acid-house
              - acoustic
              - afrobeat
              - blues
              - dance
              - disco
              - drum-and-bass
              - edm
              - hard-techno
              - hip-hop
              - hits
              - indie
              - jazz
              - kizomba
              - latin
              - melodic-techno
              - metal
              - minimal
              - old-school
              - pop
              - r&b
              - reggae
              - reggaeton
              - remember
              - rock
              - salsa
              - sing-along
              - soul
              - tech-house
              - techno
              - trap
              - underground
              - urban
        artists:
          type: array
          items:
            $ref: '#/components/schemas/Artist'
        location_id:
          type: string
          example: locAbcdefghi1234567890
          description: Unique identifier of the location.
        location:
          $ref: '#/components/schemas/Location'
        event_group:
          $ref: '#/components/schemas/EventGroup'
        ticket_rates:
          type: array
          items:
            $ref: '#/components/schemas/TicketRate'
        iframe:
          type: object
          properties:
            tag_url:
              type: string
              example: https://fourvenues.com/assets/org-slug/event-code
              description: >-
                The URL of iframe in order to put it on the iframe tag (not
                auto-resizable).
            script_url:
              type: string
              example: https://fourvenues.com/assets/iframe/org-slug/event-code
              description: >-
                The URL of script in order to put it as an script
                (auto-resizable).
        currency:
          type: string
          example: EUR
          description: Currency of the event.
      required:
        - _id
        - name
        - slug
        - description
        - startDate
        - endDate
        - organizationId
        - artists
        - outfit
        - music_genres
        - age
        - ambiences
        - locationId
    Artist:
      type: object
      description: >-
        Basic information about an artist. Information is preretrieved from
        Spotify.
      properties:
        name:
          type: string
          example: C. Tangana
          description: Artist name.
        image_url:
          type: string
          example: https://somecdn.com/random-hash
          description: Artist cover.
    Location:
      type: object
      description: >-
        Complete information of an specific location. Also contains timezone
        information.
      properties:
        unic_id:
          type: string
          description: Unique identifier of the location inside an organization.
          example: orgAbcdefghi1234567890-locAbcdefghi1234567890
        location_id:
          type: string
          description: Unique identifier of the location.
          example: 5e4f4b1b1f6b4b001f6b4b001
        organization_id:
          type: string
          description: Unique identifier of the organization.
          example: 5e4f4b1b1f6b4b001f6b4b001
        name:
          type: string
          description: Location's name in the organization.
          example: Valencia
        address:
          type: string
          description: Location's addresss.
          example: Carrer de Salamanca
        number:
          type: string
          description: Number of the address.
          example: '43'
        city:
          type: string
          description: Location's city.
          example: Valencia
        country:
          type: string
          description: Location's country.
          example: Spain
        full_address:
          type: string
          description: Full address of the location.
          example: Carrer de Salamanca, 43, Valencia, Spain
        latitude:
          type: number
          format: number
          description: Location's latitude.
          example: 39.4651339
        longitude:
          type: number
          format: number
          description: Location's longitude.
          example: -0.3658872
        timezone:
          type: string
          description: Location's timezone.
          example: Europe/Madrid
      required:
        - unic_id
        - location_id
        - organization_id
        - name
        - address
        - number
        - city
        - country
        - full_address
        - latitude
        - longitude
        - timezone
    EventGroup:
      type: object
      description: A group of events belonging to an organization.
      properties:
        _id:
          type: string
          description: Unique identifier of the event group.
          example: p03zns27fhz7opf9lqulc1scg9ke5z1y
        organization_id:
          type: string
          description: Unique identifier of the organization.
          example: Mjo4f9o9h01fdjvmmrgn9aoh4s5IBHzX
        name:
          type: string
          description: Name of the event group.
          example: CM EVENTS
        description:
          type: string
          nullable: true
          description: Description of the event group.
        event_ids:
          type: array
          items:
            type: string
          description: Event ids included in the group that are accessible for the channel.
      required:
        - _id
        - organization_id
        - name
        - event_ids
    TicketRate:
      type: object
      properties:
        _id:
          type: string
          example: abcdefghi1234567890
          description: Ticket rate unique identifier.
        organization_id:
          type: string
          example: abcdefghi1234567890
          description: Ticket rate organization unique identifier.
        event_id:
          type: string
          example: abcdefghi1234567890
          description: Event unique identifier.
        name:
          type: string
          example: General Access
          description: Name of the ticket rate.
        slug:
          type: string
          example: general-access
          description: Name URL-friendly identifier.
        valid_from:
          type: string
          example: '2022-01-01T00:00:00.000Z'
          description: Date when the ticket rate will be available for sale.
        complete:
          type: boolean
          example: false
          description: If the ticket rate is marked as complete.
        type:
          type: string
          example: limited
          enum:
            - limited
            - public
        show_all_prices:
          type: boolean
          example: true
          description: If the ticket rate is configured to show all prices.
        prices:
          type: array
          items:
            $ref: '#/components/schemas/PriceTicketRate'
          description: Prices of the ticket rate.
        supplements:
          type: array
          items:
            $ref: '#/components/schemas/Supplement'
          description: >-
            Optional add-ons for this ticket rate. Paid supplements increase the
            ticket price; free supplements (price 0) are added automatically
            when omitted from checkout. Purchase limits apply at checkout
            (duplicate supplement_id entries are collapsed first).
            redemption_deadline is stored on the ticket for redemption at the
            event, not validated at purchase time.
        available:
          type: boolean
          example: true
          description: If the ticket rate is available.
        current_price:
          $ref: '#/components/schemas/PriceTicketRate'
          description: Current price available of the ticket rate.
        warranty:
          type: object
          properties:
            enabled:
              type: boolean
              example: true
              description: If the warranty is enabled.
            percentage:
              type: number
              example: 20
              description: >-
                Cost of the warranty (applying the percentage to the final price
                of the ticket).
            hours:
              type: number
              example: 12
              description: Hours before the event the warranty can be used.
        availability:
          type: object
          properties:
            sold:
              type: number
              example: 10
              description: Number of tickets sold by the channel.
            available:
              type: number
              example: 90
              description: Number of tickets available to buy.
        min:
          type: number
          example: 1
          description: Minimum number of tickets that can be purchased in a single order.
        max:
          type: number
          example: 10
          description: Maximum number of tickets that can be purchased in a single order.
        questions:
          type: array
          items:
            $ref: '#/components/schemas/Question'
          description: Questions of the ticket rate.
        has_discount_codes_enabled:
          type: boolean
          example: true
          description: Wether there is any discount code enabled for this ticket rate
      required:
        - id
        - organization_id
        - event_id
        - name
        - slug
        - valid_from
        - complete
        - type
        - prices
        - supplements
        - min
        - max
        - available
        - availability
        - questions
    PriceTicketRate:
      type: object
      description: >-
        A ticket rate can have one or multiple prices but only one can be active
        at a time.
      properties:
        _id:
          type: string
          example: '1643064796675'
          description: Unique identifier for the price.
        name:
          type: string
          example: Early Bird
          description: Name of the price.
        price:
          type: number
          example: 12
          description: Price of the ticket.
        valid_until:
          type: string
          example: '2022-01-01T00:00:00.000Z'
          description: Date until the price will be available.
        quantity:
          type: number
          example: 0
          description: >-
            Max number of tickets that can be purchased with this price. NOTE: 0
            means unlimited.
        fee_type:
          type: string
          example: percentage
          enum:
            - percentage
            - fixed
          description: Type of the fee.
        fee_quantity:
          type: number
          example: 10
          description: Quantity of the fee.
        includes:
          type: string
          example: 1 Drink
          description: Content the price includes.
        additional_info:
          type: string
          example: Only valid before 2:00 am.
          description: Additional info.
        used:
          type: number
          example: '55'
          description: Number of tickets sold of this price
      required:
        - id
        - price
        - valid_until
        - quantity
        - includes
        - additional_info
    Supplement:
      type: object
      description: Ticket rate supplement (add-on) configuration.
      properties:
        _id:
          type: string
          example: '1643064796675'
          description: Unique identifier for the supplement.
        label:
          type: string
          example: 1 Copa
          description: Display label of the supplement.
        price:
          type: number
          example: 12
          description: >-
            Unit price per supplement pack. When 0, the supplement is free (one
            pack is added per ticket with purchase_quantity 1).
        has_fake_price:
          type: boolean
          example: true
          description: >-
            When true, fake_price is shown as the original price before
            discount.
        fake_price:
          type: number
          example: 15
          description: Original price shown to the customer when has_fake_price is true.
        description:
          type: string
          example: Includes one drink at the bar
          description: Longer description of the supplement.
        product_quantity:
          type: number
          example: 4
          description: >-
            Redeemable items per purchased pack (e.g. 4 drinks inside each
            pack). On the ticket, purchase_quantity is how many packs were
            bought and product_quantity is copied from the rate.
        purchase_limit:
          $ref: '#/components/schemas/SupplementPurchaseLimit'
        redemption_deadline:
          $ref: '#/components/schemas/SupplementRedemptionDeadline'
        service_charge_amount:
          type: number
          example: 15
          description: >-
            Service charge amount. Interpreted as a fixed amount or percentage
            depending on service_charge_type.
        service_charge_type:
          type: string
          enum:
            - fixed
            - percentage
          example: percentage
          description: How service_charge_amount is applied to the supplement unit price.
    Question:
      type: object
      properties:
        _id:
          type: string
          example: '1643064796675'
          description: Unique identifier for the question.
        label:
          type: string
          example: ¿How did you hear about us?
          description: Label of the question.
        type:
          type: string
          example: dropdown
          enum:
            - text
            - dropdown
        required:
          type: boolean
          example: true
          description: If the question is required.
        items:
          type: array
          items:
            type: string
          description: Options of the question.
          example:
            - Instagram
            - Appear
      required:
        - _id
        - label
        - type
        - required
    SupplementPurchaseLimit:
      type: object
      description: Quantity constraints applied when purchasing a paid supplement.
      properties:
        min_quantity:
          type: number
          example: 2
          description: >-
            Minimum units that must be purchased when this supplement is
            selected.
        max_quantity:
          type: number
          example: 8
          description: Maximum units allowed per ticket when is_unlimited is false.
        is_unlimited:
          type: boolean
          example: false
          description: When true, max_quantity is ignored.
    SupplementRedemptionDeadline:
      type: object
      description: >-
        Redemption window for the supplement at the event. Copied to the ticket
        as redemption_deadline_value; not enforced during checkout or ticket
        creation.
      properties:
        is_expiration_enabled:
          type: boolean
          example: true
          description: Whether expiration_deadline is enforced.
        expiration_deadline:
          type: number
          example: 1798851600
          description: >-
            Unix timestamp (seconds) after which the supplement cannot be
            purchased.
  securitySchemes:
    ApiKey:
      in: header
      name: X-Api-Key
      type: apiKey

````