Skip to content
KynectLocal Docs

List active/upcoming events for a brand

GET
/public/events/active
 
curl --request GET \
  --url 'https://kynectlocal-production.up.railway.app/v1/public/events/active?brandId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
brandId
required
string format: uuid

Brand identifier

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
data
required
object
events
required
Array<object>
object
id
required

Event identifier

string format: uuid
brandId
required

Parent brand

string format: uuid
locationId
required

Location scope

string | null format: uuid
title
required

Event title

string
slug
required

URL slug

string
status
required

Publication status

string
Allowed values: DRAFT PUBLISHED
startDate
required

Event start datetime

string format: date-time
endDate
required

Event end datetime

string | null format: date-time
imageUrl
required

Event image URL

string | null
body
required

Event description/body HTML

string | null
ctaLabel
required

CTA button label

string | null
ctaUrl
required

CTA URL

string | null
Example 
{
  "data": {
    "events": [
      {
        "status": "DRAFT"
      }
    ]
  }
}

400

Section titled “400 ”

Validation error

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Section titled “422 ”

Unprocessable

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}