Get list by id

cURL

curl --request GET \
  --url https://api-alpha.fourvenues.com/integrations/lists/{listId} \
  --header 'integration_id: <api-key>' \
  --header 'secret: <api-key>' \
  --header 'x-api-key: <api-key>'

{
  "success": true,
  "data": {
    "_id": "Pl4gr84v20xqu01js0ybj42s6vYtIz1T",
    "channel_id": "ajifs2hke000dwemmurwd3kuqN3Kopcx",
    "code": "P6J21FF2S",
    "enter": 4,
    "event_id": "Mjo4f9o9h01fdjvmmrgn9aoh4s5IBHzX",
    "for": 7,
    "name": "Miguel Román",
    "observations_reception": "Birthday",
    "rate_id": "Tl4gr63fr0xkr01i1gk354qbrSCMLTwl",
    "rate_name": "General Access",
    "rate_slug": "general-access",
    "referral_id": "ñeifupjvx000rwe2m2zuba1z9FqyR2dSL",
    "referral": {
      "_id": "eifupjvx000rwe2m2zuba1z9FqyR2dSL",
      "name": "John Appleseed"
    },
    "options": [
      {
        "_id": "1712861139741",
        "women": 1,
        "men": 1,
        "no_gender": 0,
        "price": 10,
        "total": 2
      }
    ],
    "tags": [
      "birthday",
      "free-access"
    ],
    "removed_at": 0
  }
}

GET

lists

{listId}

cURL

curl --request GET \
  --url https://api-alpha.fourvenues.com/integrations/lists/{listId} \
  --header 'integration_id: <api-key>' \
  --header 'secret: <api-key>' \
  --header 'x-api-key: <api-key>'

{
  "success": true,
  "data": {
    "_id": "Pl4gr84v20xqu01js0ybj42s6vYtIz1T",
    "channel_id": "ajifs2hke000dwemmurwd3kuqN3Kopcx",
    "code": "P6J21FF2S",
    "enter": 4,
    "event_id": "Mjo4f9o9h01fdjvmmrgn9aoh4s5IBHzX",
    "for": 7,
    "name": "Miguel Román",
    "observations_reception": "Birthday",
    "rate_id": "Tl4gr63fr0xkr01i1gk354qbrSCMLTwl",
    "rate_name": "General Access",
    "rate_slug": "general-access",
    "referral_id": "ñeifupjvx000rwe2m2zuba1z9FqyR2dSL",
    "referral": {
      "_id": "eifupjvx000rwe2m2zuba1z9FqyR2dSL",
      "name": "John Appleseed"
    },
    "options": [
      {
        "_id": "1712861139741",
        "women": 1,
        "men": 1,
        "no_gender": 0,
        "price": 10,
        "total": 2
      }
    ],
    "tags": [
      "birthday",
      "free-access"
    ],
    "removed_at": 0
  }
}

Authorizations

integration_id

string

header

required

Identifier of the integration (Auth v1)

secret

string

header

required

Secret of the organization (Auth v1)

x-api-key

string

header

required

API key (Auth v2)

Path Parameters

listId

string

required

List identifier.

Response

HTTP OK

success

boolean

Example:

true

data

object

Show child attributes

data._id

string

Unique ID of the list.

Example:

"Pl4gr84v20xqu01js0ybj42s6vYtIz1T"

data.channel_id

string

Unique identifier of the channel. (It can be the same or other organization).

Example:

"ajifs2hke000dwemmurwd3kuqN3Kopcx"

data.code

string

Access code (QR) of the list.

Example:

"P6J21FF2S"

data.enter

integer

default:0

Number of people entered.

Example:

4

data.event_id

string

Event identifier.

Example:

"Mjo4f9o9h01fdjvmmrgn9aoh4s5IBHzX"

data.for

integer

Number of people enlisted.

Example:

7

data.name

string

Name of the guest.

Example:

"Miguel Román"

data.observations_reception

string

Notes that will be shown to hostess.

Example:

"Birthday"

data.rate_id

string

Rate identifier.

Example:

"Tl4gr63fr0xkr01i1gk354qbrSCMLTwl"

data.rate_name

string

Rate name.

Example:

"General Access"

data.rate_slug

string

Rate slug.

Example:

"general-access"

data.referral_id

string

PPRR identifier.

Example:

"ñeifupjvx000rwe2m2zuba1z9FqyR2dSL"

data.referral

object

Show child attributes

data.referral._id

string

Unique ID of the referral.

Example:

"eifupjvx000rwe2m2zuba1z9FqyR2dSL"

data.referral.name

string

Name of the referral.

Example:

"John Appleseed"

data.options

object[]

Show child attributes

data.options._id

string

Unique ID of the option.

Example:

"1712861139741"

data.options.women

number

Number of women in the list option.

Example:

1

data.options.men

number

Number of men in the list option.

Example:

1

data.options.no_gender

number

Number of no gender in the list option.

Example:

0

data.options.price

number

Price of the option.

Example:

10

data.options.total

number

Total of people in the list option.

Example:

2

data.tags

string[]

Tags of the list.

Example:

["birthday", "free-access"]

data.removed_at

integer

Timestamp when the list was removed.

Example:

0

Get channels Get lists

⌘I

Introduction

API Reference

Recipes

Authorizations

Path Parameters

Response