Skip to content
EventPoint Developer Documentation

Get project

GET
/api/projects/{projectid}
curl --request GET \
  --url https://api.eventpoint.io/api/projects/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”
projectid
required
string format: uuid

The project 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
subscriptionId
string format: uuid
subscriptionLevel
Allowed values: Free Professional Organizations Enterprise Custom
userId
string format: uuid
createdByUserId
string format: uuid
organizationId
null | string format: uuid
name
null | string
code
null | string
description
null | string
flagLevel
Allowed values: OK Annoying Abusive Spam FreakingSpam
url
null | string
useCustomUrl
boolean
isArchived
boolean
isOffline
boolean
isTemplate
boolean
isLocked
boolean
isDefault
boolean
externalUrl
null | string
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
customUrl
null | string
timezone
null | string
publish
boolean
useOrgPayment
boolean
hasChecklist
boolean
hasMetaFields
boolean
reactionSummary
null | string
meta
null | object
profileImages
object
defaultOriginal
null | string
defaultLarge
null | string
defaultMedium
null | string
defaultSmall
null | string
thumbnailSmall
null | string
thumbnailLarge
null | string
settings
object
onsiteEnabled
boolean
showAiTab
boolean
aiOverviewEnabled
null | boolean
enableSSO
boolean
requireAccountVerify
boolean
allowEmailMatchSignIn
boolean
allowMatchingExistingAccount
boolean
allowedSSODomains
null | string
unauthenticatedDefaultRedirect
null | string
projectLabelPlural
null | string
projectLabel
null | string
companyLabelPlural
null | string
companyLabel
null | string
showCompanyNav
boolean
facilitatorLabelPlural
null | string
facilitatorLabel
null | string
attendeeLabelPlural
null | string
attendeeLabel
null | string
contextEventId
null | string format: uuid
contextEventTypeId
null | string format: uuid
eventLabel
null | string
eventLabelPlural
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