Get all events

GET

events

curl --request GET \
  --url https://channels-service-alpha.fourvenues.com/events \
  --header 'X-Api-Key: <api-key>'

{
  "data": [
    {
      "_id": "abcdefghi1234567890",
      "name": "Monday Night",
      "slug": "monday-night",
      "description": "Lorem ipsum",
      "display_date": "2023-12-31T00:00:00.000Z",
      "start_date": "2024-01-01T00:00:00.000Z",
      "end_date": "2024-01-01T06:00:00.000Z",
      "organization_id": "abcdefghi1234567890",
      "age": "18",
      "image_url": "https://somecdn.com/random-hash",
      "outfit": "casual",
      "ambiences": [
        "alternative"
      ],
      "music_genres": [
        "bachata"
      ],
      "artists": [
        {
          "name": "C. Tangana",
          "image_url": "https://somecdn.com/random-hash"
        }
      ],
      "location_id": "locAbcdefghi1234567890",
      "location": {
        "unic_id": "orgAbcdefghi1234567890-locAbcdefghi1234567890",
        "location_id": "5e4f4b1b1f6b4b001f6b4b001",
        "organization_id": "5e4f4b1b1f6b4b001f6b4b001",
        "name": "Valencia",
        "address": "Carrer de Salamanca",
        "number": "43",
        "city": "Valencia",
        "country": "Spain",
        "full_address": "Carrer de Salamanca, 43, Valencia, Spain",
        "latitude": 39.4651339,
        "longitude": -0.3658872,
        "timezone": "Europe/Madrid"
      },
      "ticket_rates": [
        {
          "_id": "abcdefghi1234567890",
          "organization_id": "abcdefghi1234567890",
          "event_id": "abcdefghi1234567890",
          "name": "General Access",
          "slug": "general-access",
          "valid_from": "2022-01-01T00:00:00.000Z",
          "complete": false,
          "type": "limited",
          "show_all_prices": true,
          "prices": [
            {
              "_id": "1643064796675",
              "name": "Early Bird",
              "price": 12,
              "valid_until": "2022-01-01T00:00:00.000Z",
              "quantity": 0,
              "fee_type": "percentage",
              "fee_quantity": 10,
              "includes": "1 Drink",
              "additional_info": "Only valid before 2:00 am."
            }
          ],
          "supplements": [
            {
              "_id": "1643064796675",
              "label": "1 Copa",
              "price": 12,
              "has_fake_price": false,
              "fake_price": 15
            }
          ],
          "available": true,
          "current_price": {
            "_id": "1643064796675",
            "name": "Early Bird",
            "price": 12,
            "valid_until": "2022-01-01T00:00:00.000Z",
            "quantity": 0,
            "fee_type": "percentage",
            "fee_quantity": 10,
            "includes": "1 Drink",
            "additional_info": "Only valid before 2:00 am."
          },
          "warranty": {
            "enabled": true,
            "percentage": 20,
            "hours": 12
          },
          "availability": {
            "sold": 10,
            "available": 90
          },
          "min": 1,
          "max": 10,
          "questions": [
            {
              "_id": "1643064796675",
              "label": "¿How did you hear about us?",
              "type": "dropdown",
              "required": true,
              "items": [
                "Instagram",
                "Appear"
              ]
            }
          ]
        }
      ],
      "iframe": {
        "tag_url": "https://fourvenues.com/assets/org-slug/event-code",
        "script_url": "https://fourvenues.com/assets/iframe/org-slug/event-code"
      }
    }
  ],
  "success": true
}

Authorizations

X-Api-Key

string

header

required

Query Parameters

organization_id

string

Filter the events by organization id.

start_date

string

Filter the events by start date.

end_date

string

Filter the events by end date.

populate

string

Populates the events with the options given separated by comma.<br>Populate options:<br> -'*': All populators<br> -'ticket-rates': Ticket Rates

string

Each word in search must be in the events name to return it.<br>Example if an event name is 'Fourvenues New Disco' and we search for 'fourven disc' the event should be returned.

location_id

string

Filter the events by location id.

lat

number

Filter by zone radius. Latitude of the center radius. This field is required if lng or radius are pass.

lng

number

Filter by zone radius. Longitude of the center radius. This field is required if lat or radius are pass

radius

number

default:5

Filter by zone radius. Radius of the zone to search in kilometers (Max 500). This field is required if lng or lat are pass

limit

integer

default:50

Limit the number of events returned.

offset

integer

default:0

Offset the events returned.

Response

200

application/json

data

object[]

data._id

string

required

Unique identifier of the event.

Example:

"abcdefghi1234567890"

data.name

string

required

Name of the event.

Example:

"Monday Night"

data.slug

string

required

Slug of the event.

Example:

"monday-night"

data.description

string

required

Description of the event.

Example:

"Lorem ipsum"

data.age

number

required

Minimum age.

Example:

"18"

data.outfit

enum<string>

required

Dresscode of the event.

Available options:

free,

casual,

formal,

black-tie,

smart

Example:

"casual"

data.ambiences

enum<string>[]

required

Ambience of the event.

Available options:

lgtbiqplus,

alternative,

erasmus,

international,

underground,

university,

urban,

young

data.music_genres

enum<string>[]

required

Music genre of the event.

Available options:

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

data.artists

object[]

required

Basic information about an artist. Information is preretrieved from Spotify.

data.display_date

string

Date that should be displayed as the date of the event.

Example:

"2023-12-31T00:00:00.000Z"

data.start_date

string

Legal start date of the event.

Example:

"2024-01-01T00:00:00.000Z"

data.end_date

string

Legal end date of the event.

Example:

"2024-01-01T06:00:00.000Z"

data.organization_id

string

Unique identifier for the organization.

Example:

"abcdefghi1234567890"

data.image_url

string

Flyer of the event.

Example:

"https://somecdn.com/random-hash"

data.location_id

string

Unique identifier of the location.

Example:

"locAbcdefghi1234567890"

data.location

object

Complete information of an specific location. Also contains timezone information.

data.ticket_rates

object[]

data.ticket_rates.organization_id

string

required

Ticket rate organization unique identifier.

Example:

"abcdefghi1234567890"

data.ticket_rates.event_id

string

required

Event unique identifier.

Example:

"abcdefghi1234567890"

data.ticket_rates.name

string

required

Name of the ticket rate.

Example:

"General Access"

data.ticket_rates.slug

string

required

Name URL-friendly identifier.

Example:

"general-access"

data.ticket_rates.valid_from

string

required

Date when the ticket rate will be available for sale.

Example:

"2022-01-01T00:00:00.000Z"

data.ticket_rates.complete

boolean

required

If the ticket rate is marked as complete.

Example:

false

data.ticket_rates.type

enum<string>

required

Available options:

limited,

public

Example:

"limited"

data.ticket_rates.prices

object[]

required

Prices of the ticket rate.

A ticket rate can have one or multiple prices but only one can be active at a time.

data.ticket_rates.supplements

object[]

required

Supplements of the ticket rate. Each supplement increases the price of the ticket.

data.ticket_rates.available

boolean

required

If the ticket rate is available.

Example:

true

data.ticket_rates.availability

object

required

data.ticket_rates.min

number

required

Minimum number of tickets that can be purchased in a single order.

Example:

1

data.ticket_rates.max

number

required

Maximum number of tickets that can be purchased in a single order.

Example:

10

data.ticket_rates.questions

object[]

required

Questions of the ticket rate.

data.ticket_rates.questions._id

string

required

Unique identifier for the question.

Example:

"1643064796675"

data.ticket_rates.questions.label

string

required

Label of the question.

Example:

"¿How did you hear about us?"

data.ticket_rates.questions.type

enum<string>

required

Available options:

text,

dropdown

Example:

"dropdown"

data.ticket_rates.questions.required

boolean

required

If the question is required.

Example:

true

data.ticket_rates.questions.items

string[]

Options of the question.

Example:

["Instagram", "Appear"]

data.ticket_rates._id

string

Ticket rate unique identifier.

Example:

"abcdefghi1234567890"

data.ticket_rates.show_all_prices

boolean

If the ticket rate is configured to show all prices.

Example:

true

data.ticket_rates.current_price

object

Current price available of the ticket rate.

data.ticket_rates.warranty

object

data.iframe

object

success

boolean

Get auth information Get an event by id

curl --request GET \
  --url https://channels-service-alpha.fourvenues.com/events \
  --header 'X-Api-Key: <api-key>'

{
  "data": [
    {
      "_id": "abcdefghi1234567890",
      "name": "Monday Night",
      "slug": "monday-night",
      "description": "Lorem ipsum",
      "display_date": "2023-12-31T00:00:00.000Z",
      "start_date": "2024-01-01T00:00:00.000Z",
      "end_date": "2024-01-01T06:00:00.000Z",
      "organization_id": "abcdefghi1234567890",
      "age": "18",
      "image_url": "https://somecdn.com/random-hash",
      "outfit": "casual",
      "ambiences": [
        "alternative"
      ],
      "music_genres": [
        "bachata"
      ],
      "artists": [
        {
          "name": "C. Tangana",
          "image_url": "https://somecdn.com/random-hash"
        }
      ],
      "location_id": "locAbcdefghi1234567890",
      "location": {
        "unic_id": "orgAbcdefghi1234567890-locAbcdefghi1234567890",
        "location_id": "5e4f4b1b1f6b4b001f6b4b001",
        "organization_id": "5e4f4b1b1f6b4b001f6b4b001",
        "name": "Valencia",
        "address": "Carrer de Salamanca",
        "number": "43",
        "city": "Valencia",
        "country": "Spain",
        "full_address": "Carrer de Salamanca, 43, Valencia, Spain",
        "latitude": 39.4651339,
        "longitude": -0.3658872,
        "timezone": "Europe/Madrid"
      },
      "ticket_rates": [
        {
          "_id": "abcdefghi1234567890",
          "organization_id": "abcdefghi1234567890",
          "event_id": "abcdefghi1234567890",
          "name": "General Access",
          "slug": "general-access",
          "valid_from": "2022-01-01T00:00:00.000Z",
          "complete": false,
          "type": "limited",
          "show_all_prices": true,
          "prices": [
            {
              "_id": "1643064796675",
              "name": "Early Bird",
              "price": 12,
              "valid_until": "2022-01-01T00:00:00.000Z",
              "quantity": 0,
              "fee_type": "percentage",
              "fee_quantity": 10,
              "includes": "1 Drink",
              "additional_info": "Only valid before 2:00 am."
            }
          ],
          "supplements": [
            {
              "_id": "1643064796675",
              "label": "1 Copa",
              "price": 12,
              "has_fake_price": false,
              "fake_price": 15
            }
          ],
          "available": true,
          "current_price": {
            "_id": "1643064796675",
            "name": "Early Bird",
            "price": 12,
            "valid_until": "2022-01-01T00:00:00.000Z",
            "quantity": 0,
            "fee_type": "percentage",
            "fee_quantity": 10,
            "includes": "1 Drink",
            "additional_info": "Only valid before 2:00 am."
          },
          "warranty": {
            "enabled": true,
            "percentage": 20,
            "hours": 12
          },
          "availability": {
            "sold": 10,
            "available": 90
          },
          "min": 1,
          "max": 10,
          "questions": [
            {
              "_id": "1643064796675",
              "label": "¿How did you hear about us?",
              "type": "dropdown",
              "required": true,
              "items": [
                "Instagram",
                "Appear"
              ]
            }
          ]
        }
      ],
      "iframe": {
        "tag_url": "https://fourvenues.com/assets/org-slug/event-code",
        "script_url": "https://fourvenues.com/assets/iframe/org-slug/event-code"
      }
    }
  ],
  "success": true
}

Introduction

API Reference

Webhooks

Recipes

Authorizations

Query Parameters

Response