Get an event by id

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

{
  "data": {
    "_id": "abcdefghi1234567890",
    "name": "Monday Night",
    "slug": "monday-night",
    "description": "Lorem ipsum",
    "age": "18",
    "outfit": "casual",
    "ambiences": [
      "alternative"
    ],
    "music_genres": [
      "bachata"
    ],
    "artists": [
      {
        "name": "C. Tangana",
        "image_url": "https://somecdn.com/random-hash"
      }
    ],
    "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",
    "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": [
      {
        "organization_id": "abcdefghi1234567890",
        "event_id": "abcdefghi1234567890",
        "name": "General Access",
        "slug": "general-access",
        "valid_from": "2022-01-01T00:00:00.000Z",
        "complete": false,
        "type": "limited",
        "prices": [
          {
            "price": 12,
            "valid_until": "2022-01-01T00:00:00.000Z",
            "quantity": 0,
            "includes": "1 Drink",
            "additional_info": "Only valid before 2:00 am.",
            "_id": "1643064796675",
            "name": "Early Bird",
            "fee_type": "percentage",
            "fee_quantity": 10
          }
        ],
        "supplements": [
          {
            "_id": "1643064796675",
            "label": "1 Copa",
            "price": 12,
            "has_fake_price": false,
            "fake_price": 15
          }
        ],
        "available": true,
        "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"
            ]
          }
        ],
        "_id": "abcdefghi1234567890",
        "show_all_prices": true,
        "current_price": {
          "price": 12,
          "valid_until": "2022-01-01T00:00:00.000Z",
          "quantity": 0,
          "includes": "1 Drink",
          "additional_info": "Only valid before 2:00 am.",
          "_id": "1643064796675",
          "name": "Early Bird",
          "fee_type": "percentage",
          "fee_quantity": 10
        },
        "warranty": {
          "enabled": true,
          "percentage": 20,
          "hours": 12
        }
      }
    ],
    "iframe": {
      "tag_url": "https://fourvenues.com/assets/org-slug/event-code",
      "script_url": "https://fourvenues.com/assets/iframe/org-slug/event-code"
    }
  },
  "success": true
}

GET

events

{id}

Get an event by id

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

{
  "data": {
    "_id": "abcdefghi1234567890",
    "name": "Monday Night",
    "slug": "monday-night",
    "description": "Lorem ipsum",
    "age": "18",
    "outfit": "casual",
    "ambiences": [
      "alternative"
    ],
    "music_genres": [
      "bachata"
    ],
    "artists": [
      {
        "name": "C. Tangana",
        "image_url": "https://somecdn.com/random-hash"
      }
    ],
    "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",
    "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": [
      {
        "organization_id": "abcdefghi1234567890",
        "event_id": "abcdefghi1234567890",
        "name": "General Access",
        "slug": "general-access",
        "valid_from": "2022-01-01T00:00:00.000Z",
        "complete": false,
        "type": "limited",
        "prices": [
          {
            "price": 12,
            "valid_until": "2022-01-01T00:00:00.000Z",
            "quantity": 0,
            "includes": "1 Drink",
            "additional_info": "Only valid before 2:00 am.",
            "_id": "1643064796675",
            "name": "Early Bird",
            "fee_type": "percentage",
            "fee_quantity": 10
          }
        ],
        "supplements": [
          {
            "_id": "1643064796675",
            "label": "1 Copa",
            "price": 12,
            "has_fake_price": false,
            "fake_price": 15
          }
        ],
        "available": true,
        "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"
            ]
          }
        ],
        "_id": "abcdefghi1234567890",
        "show_all_prices": true,
        "current_price": {
          "price": 12,
          "valid_until": "2022-01-01T00:00:00.000Z",
          "quantity": 0,
          "includes": "1 Drink",
          "additional_info": "Only valid before 2:00 am.",
          "_id": "1643064796675",
          "name": "Early Bird",
          "fee_type": "percentage",
          "fee_quantity": 10
        },
        "warranty": {
          "enabled": true,
          "percentage": 20,
          "hours": 12
        }
      }
    ],
    "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

Path Parameters

string

required

The id of the event to retrieve.

Query Parameters

populate

string

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

Response

data

object

Show child attributes

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

Show child attributes

data.artists.name

string

Artist name.

Example:

"C. Tangana"

data.artists.image_url

string

Artist cover.

Example:

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

data.display_date

string<date-time>

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

Example:

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

data.start_date

string<date-time>

Legal start date of the event.

Example:

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

data.end_date

string<date-time>

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.

Show child attributes

data.location.unic_id

string

required

Unique identifier of the location inside an organization.

Example:

"orgAbcdefghi1234567890-locAbcdefghi1234567890"

data.location.location_id

string

required

Unique identifier of the location.

Example:

"5e4f4b1b1f6b4b001f6b4b001"

data.location.organization_id

string

required

Unique identifier of the organization.

Example:

"5e4f4b1b1f6b4b001f6b4b001"

data.location.name

string

required

Location's name in the organization.

Example:

"Valencia"

data.location.address

string

required

Location's addresss.

Example:

"Carrer de Salamanca"

data.location.number

string

required

Number of the address.

Example:

"43"

data.location.city

string

required

Location's city.

Example:

"Valencia"

data.location.country

string

required

Location's country.

Example:

"Spain"

data.location.full_address

string

required

Full address of the location.

Example:

"Carrer de Salamanca, 43, Valencia, Spain"

data.location.latitude

number<number>

required

Location's latitude.

Example:

39.4651339

data.location.longitude

number<number>

required

Location's longitude.

Example:

-0.3658872

data.location.timezone

string

required

Location's timezone.

Example:

"Europe/Madrid"

data.ticket_rates

object[]

Show child attributes

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.

Show child attributes

data.ticket_rates.prices.price

number

required

Price of the ticket.

Example:

12

data.ticket_rates.prices.valid_until

string

required

Date until the price will be available.

Example:

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

data.ticket_rates.prices.quantity

number

required

Max number of tickets that can be purchased with this price.
NOTE: 0 means unlimited.

Example:

0

data.ticket_rates.prices.includes

string

required

Content the price includes.

Example:

"1 Drink"

data.ticket_rates.prices.additional_info

string

required

Additional info.

Example:

"Only valid before 2:00 am."

data.ticket_rates.prices._id

string

Unique identifier for the price.

Example:

"1643064796675"

data.ticket_rates.prices.name

string

Name of the price.

Example:

"Early Bird"

data.ticket_rates.prices.fee_type

enum<string>

Type of the fee.

Available options:

percentage,

fixed

Example:

"percentage"

data.ticket_rates.prices.fee_quantity

number

Quantity of the fee.

Example:

10

data.ticket_rates.supplements

object[]

required

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

Show child attributes

data.ticket_rates.supplements._id

string

Unique identifier for the supplement.

Example:

"1643064796675"

data.ticket_rates.supplements.label

string

Label of the supplement.

Example:

"1 Copa"

data.ticket_rates.supplements.price

number

Price of the supplement.

Example:

12

data.ticket_rates.supplements.has_fake_price

boolean

If the supplement has a fake price.

Example:

false

data.ticket_rates.supplements.fake_price

number

Fake price of the supplement.

Example:

15

data.ticket_rates.available

boolean

required

If the ticket rate is available.

Example:

true

data.ticket_rates.availability

object

required

Show child attributes

data.ticket_rates.availability.sold

number

Number of tickets sold by the channel.

Example:

10

data.ticket_rates.availability.available

number

Number of tickets available to buy.

Example:

90

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.

Show child attributes

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.

Show child attributes

data.ticket_rates.current_price.price

number

required

Price of the ticket.

Example:

12

data.ticket_rates.current_price.valid_until

string

required

Date until the price will be available.

Example:

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

data.ticket_rates.current_price.quantity

number

required

Max number of tickets that can be purchased with this price.
NOTE: 0 means unlimited.

Example:

0

data.ticket_rates.current_price.includes

string

required

Content the price includes.

Example:

"1 Drink"

data.ticket_rates.current_price.additional_info

string

required

Additional info.

Example:

"Only valid before 2:00 am."

data.ticket_rates.current_price._id

string

Unique identifier for the price.

Example:

"1643064796675"

data.ticket_rates.current_price.name

string

Name of the price.

Example:

"Early Bird"

data.ticket_rates.current_price.fee_type

enum<string>

Type of the fee.

Available options:

percentage,

fixed

Example:

"percentage"

data.ticket_rates.current_price.fee_quantity

number

Quantity of the fee.

Example:

10

data.ticket_rates.warranty

object

Show child attributes

data.ticket_rates.warranty.enabled

boolean

If the warranty is enabled.

Example:

true

data.ticket_rates.warranty.percentage

number

Cost of the warranty (applying the percentage to the final price of the ticket).

Example:

20

data.ticket_rates.warranty.hours

number

Hours before the event the warranty can be used.

Example:

12

data.iframe

object

Show child attributes

data.iframe.tag_url

string

The URL of iframe in order to put it on the iframe tag (not auto-resizable).

Example:

"https://fourvenues.com/assets/org-slug/event-code"

data.iframe.script_url

string

The URL of script in order to put it as an script (auto-resizable).

Example:

"https://fourvenues.com/assets/iframe/org-slug/event-code"

success

boolean

Get all events Get an event by slug

⌘I

Introduction

API Reference

Webhooks

Recipes

Get an event by id

Authorizations

Path Parameters

Query Parameters

Response