List Events - TKTChurch API

curl -X GET "https://api.tktchurch.com/v1/events?type=service&status=scheduled&start=2024-01-01T00:00:00Z" \
  -H "Accept: application/json"

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "Sunday Worship Service",
      "description": "Weekly Sunday worship service",
      "startDate": "2024-01-07T10:00:00Z",
      "endDate": "2024-01-07T12:00:00Z",
      "timezone": "America/New_York",
      "location": {
        "name": "Main Sanctuary",
        "address": "123 Church Street",
        "city": "New York",
        "state": "NY",
        "country": "USA",
        "postalCode": "10001",
        "coordinates": {
          "latitude": 40.7128,
          "longitude": -74.0060
        }
      },
      "type": "service",
      "status": "scheduled",
      "recurrence": {
        "frequency": "weekly",
        "interval": 1,
        "byDay": ["SU"]
      },
      "reminders": [
        {
          "type": "email",
          "minutes": 1440
        },
        {
          "type": "notification",
          "minutes": 60
        }
      ],
      "calendarLinks": {
        "google": "https://calendar.google.com/...",
        "apple": "webcal://...",
        "outlook": "https://outlook.office.com/...",
        "yahoo": "https://calendar.yahoo.com/...",
        "ics": "https://api.tktchurch.com/v1/events/123/calendar.ics"
      },
      "tags": ["worship", "sunday-service"],
      "maxCapacity": 500,
      "requiresGeolocation": true,
      "geofenceRadius": 100,
      "createdByUserId": "456e7890-f12g-34h5-i678-912345678901",
      "updatedByUserId": "456e7890-f12g-34h5-i678-912345678901",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "thumbnail": {
        "id": "789e0123-j45k-67l8-m901-234567890123",
        "url": "https://storage.tktchurch.com/thumbnails/event-123.jpg",
        "provider": "s3",
        "key": "thumbnails/event-123.jpg"
      }
    }
  ],
  "metadata": {
    "page": 1,
    "per": 10,
    "total": 50
  }
}

GET

events

curl -X GET "https://api.tktchurch.com/v1/events?type=service&status=scheduled&start=2024-01-01T00:00:00Z" \
  -H "Accept: application/json"

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "Sunday Worship Service",
      "description": "Weekly Sunday worship service",
      "startDate": "2024-01-07T10:00:00Z",
      "endDate": "2024-01-07T12:00:00Z",
      "timezone": "America/New_York",
      "location": {
        "name": "Main Sanctuary",
        "address": "123 Church Street",
        "city": "New York",
        "state": "NY",
        "country": "USA",
        "postalCode": "10001",
        "coordinates": {
          "latitude": 40.7128,
          "longitude": -74.0060
        }
      },
      "type": "service",
      "status": "scheduled",
      "recurrence": {
        "frequency": "weekly",
        "interval": 1,
        "byDay": ["SU"]
      },
      "reminders": [
        {
          "type": "email",
          "minutes": 1440
        },
        {
          "type": "notification",
          "minutes": 60
        }
      ],
      "calendarLinks": {
        "google": "https://calendar.google.com/...",
        "apple": "webcal://...",
        "outlook": "https://outlook.office.com/...",
        "yahoo": "https://calendar.yahoo.com/...",
        "ics": "https://api.tktchurch.com/v1/events/123/calendar.ics"
      },
      "tags": ["worship", "sunday-service"],
      "maxCapacity": 500,
      "requiresGeolocation": true,
      "geofenceRadius": 100,
      "createdByUserId": "456e7890-f12g-34h5-i678-912345678901",
      "updatedByUserId": "456e7890-f12g-34h5-i678-912345678901",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "thumbnail": {
        "id": "789e0123-j45k-67l8-m901-234567890123",
        "url": "https://storage.tktchurch.com/thumbnails/event-123.jpg",
        "provider": "s3",
        "key": "thumbnails/event-123.jpg"
      }
    }
  ],
  "metadata": {
    "page": 1,
    "per": 10,
    "total": 50
  }
}

Query Parameters

type

string

Filter events by type. Options:

service: Church service
meeting: Meeting
concert: Concert
workshop: Workshop
conference: Conference
social: Social event
other: Other event type

status

string

Filter events by status. Options:

scheduled: Default status for upcoming events
cancelled: Cancelled events
postponed: Postponed events
rescheduled: Rescheduled events

tag

string

Filter events by tag

start

string

Filter events starting from this date (ISO 8601 format)

end

string

Filter events ending before this date (ISO 8601 format)

Response

data

array

Array of event objects

Show Event Object

string

Unique identifier for the event (UUID)

title

string

Event title

description

string

Event description

startDate

string

Event start date and time (ISO 8601)

endDate

string

Event end date and time (ISO 8601)

timezone

string

Event timezone

location

object

Event location details

Show Location Object

name

string

Location name

address

string

Street address

city

string

City

state

string

State/Province

country

string

Country

postalCode

string

Postal code

coordinates

object

latitude

number

Location latitude

longitude

number

Location longitude

virtualMeetingUrl

string

URL for virtual meetings (if applicable)

type

string

Event type (service, meeting, concert, workshop, conference, social, other)

status

string

Event status (scheduled, cancelled, postponed, rescheduled)

recurrence

object

Event recurrence details (if recurring)

Show Recurrence Object

frequency

string

Recurrence frequency (daily, weekly, monthly, yearly)

interval

integer

Interval between occurrences

until

string

End date for recurrence (ISO 8601)

count

integer

Number of occurrences

byDay

array

Days of week (SU, MO, TU, WE, TH, FR, SA)

byMonth

array

Months (1-12)

byMonthDay

array

Days of month

excludeDates

array

Excluded dates (ISO 8601)

reminders

array

Event reminders

Show Reminder Object

type

string

Reminder type (email, notification, sms)

minutes

integer

Minutes before event

attachments

array

Event attachments

Show Attachment Object

name

string

Attachment name

url

string

Attachment URL

type

string

File type

size

integer

File size in bytes

calendarLinks

object

Calendar integration links

Show Calendar Links

google

string

Google Calendar link

apple

string

Apple Calendar link

outlook

string

Outlook Calendar link

yahoo

string

Yahoo Calendar link

ics

string

ICS file link

tags

array

Event tags

maxCapacity

integer

Maximum number of attendees (if applicable)

requiresGeolocation

boolean

Whether geolocation is required for attendance

geofenceRadius

number

Geofence radius in meters (if applicable)

createdByUserId

string

ID of user who created the event

updatedByUserId

string

ID of user who last updated the event

createdAt

string

Creation timestamp (ISO 8601)

updatedAt

string

Last update timestamp (ISO 8601)

thumbnail

object

Event thumbnail image

Show Thumbnail Object

string

Thumbnail file ID

url

string

Thumbnail URL

provider

string

Storage provider

key

string

Storage key

metadata

object

Show Metadata

page

integer

Current page number

per

integer

Items per page

total

integer

Total number of items

curl -X GET "https://api.tktchurch.com/v1/events?type=service&status=scheduled&start=2024-01-01T00:00:00Z" \
  -H "Accept: application/json"

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "Sunday Worship Service",
      "description": "Weekly Sunday worship service",
      "startDate": "2024-01-07T10:00:00Z",
      "endDate": "2024-01-07T12:00:00Z",
      "timezone": "America/New_York",
      "location": {
        "name": "Main Sanctuary",
        "address": "123 Church Street",
        "city": "New York",
        "state": "NY",
        "country": "USA",
        "postalCode": "10001",
        "coordinates": {
          "latitude": 40.7128,
          "longitude": -74.0060
        }
      },
      "type": "service",
      "status": "scheduled",
      "recurrence": {
        "frequency": "weekly",
        "interval": 1,
        "byDay": ["SU"]
      },
      "reminders": [
        {
          "type": "email",
          "minutes": 1440
        },
        {
          "type": "notification",
          "minutes": 60
        }
      ],
      "calendarLinks": {
        "google": "https://calendar.google.com/...",
        "apple": "webcal://...",
        "outlook": "https://outlook.office.com/...",
        "yahoo": "https://calendar.yahoo.com/...",
        "ics": "https://api.tktchurch.com/v1/events/123/calendar.ics"
      },
      "tags": ["worship", "sunday-service"],
      "maxCapacity": 500,
      "requiresGeolocation": true,
      "geofenceRadius": 100,
      "createdByUserId": "456e7890-f12g-34h5-i678-912345678901",
      "updatedByUserId": "456e7890-f12g-34h5-i678-912345678901",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "thumbnail": {
        "id": "789e0123-j45k-67l8-m901-234567890123",
        "url": "https://storage.tktchurch.com/thumbnails/event-123.jpg",
        "provider": "s3",
        "key": "thumbnails/event-123.jpg"
      }
    }
  ],
  "metadata": {
    "page": 1,
    "per": 10,
    "total": 50
  }
}

Download File Create Event

​Query Parameters

​Response

Query Parameters

Response