Get fields

Retrieve the fillable fields by its session.

GET


        https://api.eventgoose.com/v1/checkouts/{session}/fields

Authentication

Authenticate yourself using your organisation api token

Parameters


                        event_id

string

required

The event identifier currently used in the checkout process.

Response

200 application/json

Note

Due to a bug the tickets key is deprecated. Use the per_ticket key to get the correct data. This will be patched in the next version.

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "general": {
        "fields": [
            {
                "id": "WqDbZmM5ywM4La93",
                "name": {
                    "clean": "Phone",
                    "slug": "phone"
                },
                "type": "text",
                "is_required": false,
                "ask_individually": false,
                "ask_order": true
            }
        ]
    },
    "tickets": {
        "ticket_name": "Regular",
        "amount": 1,
        "fields": [
            {
                "id": "gbKDopEA13E8YW7d",
                "name": {
                    "clean": "Postal code",
                    "slug": "postal_code"
                },
                "type": "text",
                "is_required": false,
                "ask_individually": false,
                "ask_order": true
            }
        ]
    },
    "per_ticket": [
        {
            "ticket_id": "ZgvLVEzp1k2Wq9DP",
            "ticket_name": "VIP",
            "amount": 2,
            "fields": [
                {
                    "id": "gbKDopEA13E8YW7d",
                    "name": {
                        "clean": "Postal code",
                        "slug": "postal_code"
                    },
                    "type": "text",
                    "is_required": false,
                    "ask_individually": false,
                    "ask_order": true
                }
            ]
        },
        {
            "ticket_id": "xmbkd233Ar2Ll8Yr",
            "ticket_name": "Regular",
            "amount": 1,
            "fields": [
                {
                    "id": "gbKDopEA13E8YW7d",
                    "name": {
                        "clean": "Postal code",
                        "slug": "postal_code"
                    },
                    "type": "text",
                    "is_required": false,
                    "ask_individually": false,
                    "ask_order": true
                }
            ]
        }
    ]
}