LogoLogo
Home
  • Documentation
  • Developers
  • The Venue Developer Documentation
  • Next.js SDK
    • React Components
      • VenueContent
      • VenueImage
    • reference
      • Index
      • functions
        • VenueContent
        • VenueImage
        • getEvent
        • getEvents
        • getLocalizedContent
        • getPage
        • getPages
        • getProduct
        • getProducts
        • getProfile
        • getProfileEvents
        • getProfiles
        • getSite
        • setConfig
      • interfaces
        • NodeHandlers
        • NodeProps
        • RenderNode
      • type-aliases
        • ContentStyles
        • Event
        • GetEventData
        • GetEventError
        • GetEventResponse
        • GetEventsData
        • GetEventsError
        • GetEventsResponse
        • GetPageData
        • GetPageError
        • GetPageResponse
        • GetPagesData
        • GetPagesError
        • GetPagesResponse
        • GetProductData
        • GetProductError
        • GetProductResponse
        • GetProductsData
        • GetProductsError
        • GetProductsResponse
        • GetProfileData
        • GetProfileError
        • GetProfileEventsData
        • GetProfileEventsError
        • GetProfileEventsResponse
        • GetProfileResponse
        • GetProfilesData
        • GetProfilesError
        • GetProfilesResponse
        • GetSiteData
        • GetSiteError
        • GetSiteResponse
        • LocalizedContent
        • Location
        • MediaItem
        • NodeHandler
        • Page
        • Product
        • ProductVariant
        • Profile
        • Site
        • SiteSettings
        • TicketOnEvent
        • publishState
        • recordType
  • TypeScript SDK
    • reference
      • Index
      • functions
        • getEvent
        • getEvents
        • getLocalizedContent
        • getPage
        • getPages
        • getProduct
        • getProducts
        • getProfile
        • getProfileEvents
        • getProfiles
        • getSite
        • setConfig
      • type-aliases
        • Event
        • GetEventData
        • GetEventError
        • GetEventResponse
        • GetEventsData
        • GetEventsError
        • GetEventsResponse
        • GetPageData
        • GetPageError
        • GetPageResponse
        • GetPagesData
        • GetPagesError
        • GetPagesResponse
        • GetProductData
        • GetProductError
        • GetProductResponse
        • GetProductsData
        • GetProductsError
        • GetProductsResponse
        • GetProfileData
        • GetProfileError
        • GetProfileEventsData
        • GetProfileEventsError
        • GetProfileEventsResponse
        • GetProfileResponse
        • GetProfilesData
        • GetProfilesError
        • GetProfilesResponse
        • GetSiteData
        • GetSiteError
        • GetSiteResponse
        • LocalizedContent
        • Location
        • MediaItem
        • Page
        • Product
        • ProductVariant
        • Profile
        • Site
        • SiteSettings
        • TicketOnEvent
        • publishState
        • recordType
  • REST API
    • Api
      • V2
        • Public
          • Events
          • Pages
          • Products
          • Site
          • Profiles
            • Events
Powered by GitBook
On this page
Export as PDF
  1. REST API
  2. Api
  3. V2
  4. Public
  5. Profiles

Events

get
Authorizations
Path parameters
siteKeystringRequired
slugstringRequired
Query parameters
limitnumber | nullableOptional
pagenumber | nullableOptional
orderBystringOptional
dirstring ยท enumOptionalPossible values:
featuredboolean | nullableOptional
upcomingboolean | nullableOptional
ltnumber | nullableOptional
gtnumber | nullableOptional
legacyIdstringOptional
Responses
200
Retrieve events for a Profile
application/json
404
Profile not found
get
GET /api/v2/{siteKey}/public/profiles/{slug}/events HTTP/1.1
Host: app.venuecms.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "records": [
    {
      "id": "text",
      "siteId": "text",
      "description": "text",
      "slug": "text",
      "image": {
        "siteId": "text",
        "uploaded": true,
        "inline": true,
        "url": "text",
        "mimeType": "text",
        "size": 1,
        "metadata": {},
        "title": "text",
        "caption": "text",
        "credit": "text",
        "altText": "text"
      },
      "startDate": "text",
      "endDate": "text",
      "hasTime": true,
      "publishState": "DRAFT",
      "location": {
        "siteId": "text",
        "image": {
          "siteId": "text",
          "uploaded": true,
          "inline": true,
          "url": "text",
          "mimeType": "text",
          "size": 1,
          "metadata": {},
          "title": "text",
          "caption": "text",
          "credit": "text",
          "altText": "text"
        },
        "address": "text",
        "address2": "text",
        "state": "text",
        "region": "text",
        "city": "text",
        "zipCode": "text",
        "country": "text",
        "externalLink": "text",
        "mapLink": "text",
        "lat": 1,
        "lng": 1,
        "localizedContent": [
          {
            "siteId": "text",
            "locale": "text",
            "title": "text",
            "content": "text",
            "shortContent": "text",
            "extraContent": "text",
            "excerpt": "text",
            "metaTitle": "text",
            "metaDescription": "text",
            "keywords": "text",
            "contentJSON": {}
          }
        ],
        "isDefault": true
      },
      "artists": [
        {
          "profile": {
            "siteId": "text",
            "slug": "text",
            "image": {
              "siteId": "text",
              "uploaded": true,
              "inline": true,
              "url": "text",
              "mimeType": "text",
              "size": 1,
              "metadata": {},
              "title": "text",
              "caption": "text",
              "credit": "text",
              "altText": "text"
            },
            "localizedContent": [
              {
                "siteId": "text",
                "locale": "text",
                "title": "text",
                "content": "text",
                "shortContent": "text",
                "extraContent": "text",
                "excerpt": "text",
                "metaTitle": "text",
                "metaDescription": "text",
                "keywords": "text",
                "contentJSON": {}
              }
            ]
          }
        }
      ],
      "tickets": [
        {
          "name": "text",
          "price": 1,
          "externalLink": "text",
          "currency": "text",
          "roles": [],
          "localizedContent": [
            {
              "siteId": "text",
              "locale": "text",
              "title": "text",
              "content": "text",
              "shortContent": "text",
              "extraContent": "text",
              "excerpt": "text",
              "metaTitle": "text",
              "metaDescription": "text",
              "keywords": "text",
              "contentJSON": {}
            }
          ]
        }
      ],
      "tags": [
        {
          "tagId": "text",
          "tag": {
            "id": "text",
            "siteId": "text",
            "title": "text"
          }
        }
      ],
      "localizedContent": [
        {
          "siteId": "text",
          "locale": "text",
          "title": "text",
          "content": "text",
          "shortContent": "text",
          "extraContent": "text",
          "excerpt": "text",
          "metaTitle": "text",
          "metaDescription": "text",
          "keywords": "text",
          "contentJSON": {}
        }
      ]
    }
  ],
  "count": 1
}