API Reference

Get the user data of the current event

This API is used to get the user information of the current event to show in the admin console. Event admins and super admins can access this API. This API will return user data such as email, firstName, lastName, countryCode, userId, hasStaffAccess, and more. We need to pass the authentication key to authenticate the user, event url, and query param with addStripeLinkedCard.

Here is the description of response attributes, which returns in the form of JSON.

Attribute

Description

firstName

This contains the user's first name.

lastName

This contains the user's last name.

languageCode

This contains the user's language code.

countryCode

This contains the user's country code.

email

This contains the user's email address.

userId

This contains the user ID.

userProfilePhoto

This returns the user's profile picture.

phonenumber

This returns the user's phone number.

admin

This returns a flag that will display if the current user has admin access or not.

marketingOptIn

This returns a user who wants to receive email updates.

addressRequired

This contains information about the address being required or not based on event settings.

bidderNumber

This returns the user's bidder number generated through the bidder registration process.

hasStaffAccess

This returns a flag that will display the staff access of the current user.

EventUserInfoDto

This returns Stripe card related information such as:
cardType: This returns the card type.
defaultCard: This returns whether the card is a default card or not.
expmonth : This contains the card's expiration month.
expyear : This contains the card's expiration year.
id : This returns Stripe card id
last4 : This contains the last four digits of the connected Stripe card.

Here are the possible error messages, which will return if any condition fails or if the required data is missing for processing.

Error code

Error Description

401

You are not authorized to view this resource.

403

The resource you were trying to access is forbidden.

404

The resource you were trying to access is not found.

4040200

Event not found.

Language
Credentials
Header
Click Try It! to start a request and see the response here!