Skip to content
EventPoint Developer Documentation

Get event registrant

GET
/api/events/{eventid}/registrant/{registrantid}
curl --request GET \
  --url https://api.eventpoint.io/api/events/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/registrant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'x-api-key: <x-api-key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
eventid
required
string format: uuid

The event identifier.

registrantid
required
string format: uuid

The registrant identifier.

Responses

Section titled “Responses”

200

Section titled “200”

OK

object
id
string format: uuid
created
string format: date-time
modified
string format: date-time
etag
null | string
projectId
string format: uuid
registrationTypeId
string format: uuid
shoppingCartId
null | string format: uuid
registrationGroupId
null | string format: uuid
invoiceId
null | string format: uuid
eventId
string format: uuid
eventRegistrationDetailsId
string format: uuid
userId
null | string format: uuid
personId
null | string format: uuid
createdByUserId
null | string format: uuid
createdByPersonId
null | string format: uuid
registrationPassCodeId
null | string format: uuid
amountListed
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
amountPurchased
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
amountPaid
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
amountDiscounted
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
amountRefunded
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
transferredByUserId
null | string format: uuid
originalRegistrantId
null | string format: uuid
numberOfTickets
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
isTransferred
boolean
isCancelled
boolean
isReleased
boolean
isApproved
boolean
user
object
name
null | string
timezone
null | string
imageAssetId
null | string format: uuid
profileImages
object
defaultOriginal
null | string
defaultLarge
null | string
defaultMedium
null | string
defaultSmall
null | string
thumbnailSmall
null | string
thumbnailLarge
null | string
createdByUser
object
name
null | string
timezone
null | string
imageAssetId
null | string format: uuid
profileImages
object
defaultOriginal
null | string
defaultLarge
null | string
defaultMedium
null | string
defaultSmall
null | string
thumbnailSmall
null | string
thumbnailLarge
null | string
grabToken
null | string
needsInvoice
boolean
hasInvoice
boolean
refundRequested
boolean
refundRequestDate
null | string format: date-time
refundDate
null | string format: date-time
responseStatus
Allowed values: Incomplete InCart Complete Cancelled Transferred Abandoned Expired UnderReview Declined Invited
registrantStatus
Allowed values: Incomplete InCart Complete Cancelled Transferred Abandoned Expired UnderReview Declined Invited
paymentStatus
Allowed values: None Unpaid Paid Refunded Red
approvalStatus
Allowed values: None UnderReview Approved Declined
refundedByPersonId
null | string format: uuid
name
null | string
email
null | string
contactEmail
null | string
proxyEmail
null | string
proxyName
null | string
registeringOnBehalf
null | boolean
phone
null | string
jobTitle
null | string
company
null | string
mobile
null | string
firstName
null | string
lastName
null | string
middleName
null | string
salutation
null | string
isGroupRegistration
boolean
companyUrl
null | string
socials
null | string
address1
null | string
address2
null | string
city
null | string
state
null | string
country
null | string
postalCode
null | string
timezone
null | string
emergencyContactFirstName
null | string
emergencyContactLastName
null | string
emergencyContactEmail
null | string
emergencyContactPhone
null | string
alternateContactFirstName
null | string
alternateContactLastName
null | string
alternateContactEmail
null | string
alternateContactPhone
null | string
businessContactFirstName
null | string
businessContactLastName
null | string
businessContactEmail
null | string
businessContactPhone
null | string
businessContactAddress1
null | string
businessContactAddress2
null | string
businessContactCity
null | string
businessContactState
null | string
businessContactCountry
null | string
businessContactPostalCode
null | string
notes
null | string
requirements
null | string
purchasedForName
null | string
purchasedForEmail
null | string
extraInfo
null | string
meta
null | object
externalId
null | string
cancellationRequested
boolean
cancellationRequestDate
null | string format: date-time
cancellationDate
null | string format: date-time
cancellationRequestedByPersonId
null | string format: uuid
confirmationNumber
null | string
completeDate
null | string format: date-time
enteredCode
null | string
checkinDate
null | string format: date-time
checkedIn
boolean
checkinDateOnline
null | string format: date-time
checkedInOnline
boolean
location
null | string
description
null | string
networkingOptIn
null | boolean
imageUrl
null | string
imageAssetId
null | string format: uuid
profileImages
object
defaultOriginal
null | string
defaultLarge
null | string
defaultMedium
null | string
defaultSmall
null | string
thumbnailSmall
null | string
thumbnailLarge
null | string
registrationType
object
id
string format: uuid
created
string format: date-time
modified
string format: date-time
etag
null | string
projectId
string format: uuid
name
null | string
description
null | string
code
null | string
displayName
null | string
kind
Allowed values: Attendee Company
status
Allowed values: NotAvailable Hidden Open Closed Cancelled
completionType
integer
hasForms
boolean
hasTicket
boolean
useEventCost
boolean
registrationIsRequired
boolean
isTransferrable
boolean
canCancel
boolean
cancelByDate
null | string format: date-time
canAutoRefund
boolean
autoRefundByDate
null | string format: date-time
minutesAllowedInCart
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
preAllocated
boolean
price
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
currency
null | string
amountPerToHio
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
amountPerToUser
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
totalPaid
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
quantity
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
openDate
null | string format: date-time
closeDate
null | string format: date-time
publish
boolean
isLocked
boolean
ticketLock
boolean
requireEmailAddress
boolean
requireMobile
boolean
requirePersonalInfo
boolean
requirePersonalContact
boolean
requireBusinessInfo
boolean
requireBusinessContact
boolean
requireEmergencyContact
boolean
requireAlternateContact
boolean
requireGroupReg
boolean
allowGroupReg
boolean
requirePayment
boolean
allowTicketSelection
boolean
isResponseMasterTicket
boolean
maxTickets
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
minTickets
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
useSysPayment
boolean
paymentType
string
usePaymentCode
boolean
requireRegistrationCode
boolean
isFacilitator
boolean
cancellationType
Allowed values: ApprovalRequired Automatic
approvalKind
Allowed values: Automatic Manual
itemOrder
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
hasChecklist
boolean
hasMetaFields
boolean
style
object
hasStyle
boolean
primaryColor
null | string
secondaryColor
null | string
backgroundColor
null | string
textColor
null | string
contrastColor
null | string
fontFamily
null | string
secondaryContrastColor
null | string
imageUrl
null | string
imageAssetId
null | string format: uuid
profileImages
object
defaultOriginal
null | string
defaultLarge
null | string
defaultMedium
null | string
defaultSmall
null | string
thumbnailSmall
null | string
thumbnailLarge
null | string
rank
null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/
categories
Array<object> | null
object
id
string format: uuid
created
string format: date-time
modified
string format: date-time
etag
null | string
projectId
string format: uuid
parentId
null | string format: uuid
topLevelId
string format: uuid
currentLevel
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
itemOrder
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
displayOrder
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
code
null | string
name
null | string
description
null | string
categoryKind
Allowed values: Multi Single Tags
useForAllEventTypes
boolean
imageUrl
null | string
imageAssetId
null | string format: uuid
style
object
hasStyle
boolean
primaryColor
null | string
secondaryColor
null | string
backgroundColor
null | string
textColor
null | string
contrastColor
null | string
fontFamily
null | string
secondaryContrastColor
null | string
publish
boolean
profileImages
object
defaultOriginal
null | string
defaultLarge
null | string
defaultMedium
null | string
defaultSmall
null | string
thumbnailSmall
null | string
thumbnailLarge
null | string

403

Section titled “403”

Forbidden

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string