Events

get
Authorizations
Responses
200Success
application/json
get
GET /api/events HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
200Success
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "location": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:16:47.521Z",
      "updated_at": "2025-07-23T12:16:47.521Z",
      "name": "text",
      "address_1": "text",
      "address_2": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "country": "text",
      "is_default": true,
      "is_main": true,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    },
    "rsvps": [
      {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      }
    ],
    "registered": "text",
    "checked_in": "text",
    "registrations": "text",
    "registration_count": "text",
    "legacy_id": "text",
    "nextgen_legacy_id": "text",
    "created_at": "2025-07-23T12:16:47.521Z",
    "updated_at": "2025-07-23T12:16:47.521Z",
    "public_id": "text",
    "name": "text",
    "description": "text",
    "start_time": "2025-07-23T12:16:47.521Z",
    "end_time": "2025-07-23T12:16:47.521Z",
    "banner": "text",
    "link": "https://example.com",
    "requires_check_in": true,
    "requires_registration": true,
    "is_recurring": true,
    "is_livestream": true,
    "recurrence": "daily",
    "recurrence_days": null,
    "recurrence_custom_pattern": "text",
    "recurrence_end_date": "2025-07-23",
    "images": null,
    "location_type": "text"
  }
]
post
Authorizations
Body
idstring · uuidRead-onlyRequired
locationall ofRead-onlyRequired
registeredstringRead-onlyRequired
checked_instringRead-onlyRequired
registrationsstringRead-onlyRequired
registration_countstringRead-onlyRequired
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyRequired
public_idstring · max: 7Optional
namestring · max: 255Required
descriptionstringRequired
start_timestring · date-timeRequired
end_timestring · date-timeRequired
bannerstring | nullableOptional
linkstring · uri | nullableOptional
requires_check_inbooleanOptional
requires_registrationbooleanOptional
is_recurringbooleanOptional
is_livestreambooleanOptional
recurrenceone of | nullableOptional
string · enumOptional
  • daily - Daily
  • weekly - Weekly
  • monthly - Monthly
  • custom - Custom
Possible values:
or
undefined · enumOptionalPossible values:
or
undefined · enumOptionalPossible values:
recurrence_daysany | nullableOptional
recurrence_custom_patternstring | nullableOptional
recurrence_end_datestring · date | nullableOptional
imagesanyOptional
location_typestring | nullableOptional
Responses
201Success
application/json
post
POST /api/events HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 510

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:16:47.521Z",
  "public_id": "text",
  "name": "text",
  "description": "text",
  "start_time": "2025-07-23T12:16:47.521Z",
  "end_time": "2025-07-23T12:16:47.521Z",
  "banner": "text",
  "link": "https://example.com",
  "requires_check_in": true,
  "requires_registration": true,
  "is_recurring": true,
  "is_livestream": true,
  "recurrence": "daily",
  "recurrence_days": null,
  "recurrence_custom_pattern": "text",
  "recurrence_end_date": "2025-07-23",
  "images": null,
  "location_type": "text"
}
201Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "location": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "legacy_id": "text",
    "nextgen_legacy_id": "text",
    "created_at": "2025-07-23T12:16:47.521Z",
    "updated_at": "2025-07-23T12:16:47.521Z",
    "name": "text",
    "address_1": "text",
    "address_2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text",
    "is_default": true,
    "is_main": true,
    "church": "123e4567-e89b-12d3-a456-426614174000"
  },
  "rsvps": [
    {
      "id": "text",
      "email": "text",
      "phone": "text",
      "profile": "text",
      "additional_user_fields": "text"
    }
  ],
  "registered": "text",
  "checked_in": "text",
  "registrations": "text",
  "registration_count": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:16:47.521Z",
  "updated_at": "2025-07-23T12:16:47.521Z",
  "public_id": "text",
  "name": "text",
  "description": "text",
  "start_time": "2025-07-23T12:16:47.521Z",
  "end_time": "2025-07-23T12:16:47.521Z",
  "banner": "text",
  "link": "https://example.com",
  "requires_check_in": true,
  "requires_registration": true,
  "is_recurring": true,
  "is_livestream": true,
  "recurrence": "daily",
  "recurrence_days": null,
  "recurrence_custom_pattern": "text",
  "recurrence_end_date": "2025-07-23",
  "images": null,
  "location_type": "text"
}
get
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this event.

Responses
200Success
application/json
get
GET /api/events/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "location": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "legacy_id": "text",
    "nextgen_legacy_id": "text",
    "created_at": "2025-07-23T12:16:47.521Z",
    "updated_at": "2025-07-23T12:16:47.521Z",
    "name": "text",
    "address_1": "text",
    "address_2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text",
    "is_default": true,
    "is_main": true,
    "church": "123e4567-e89b-12d3-a456-426614174000"
  },
  "rsvps": [
    {
      "id": "text",
      "email": "text",
      "phone": "text",
      "profile": "text",
      "additional_user_fields": "text"
    }
  ],
  "registered": "text",
  "checked_in": "text",
  "registrations": "text",
  "registration_count": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:16:47.521Z",
  "updated_at": "2025-07-23T12:16:47.521Z",
  "public_id": "text",
  "name": "text",
  "description": "text",
  "start_time": "2025-07-23T12:16:47.521Z",
  "end_time": "2025-07-23T12:16:47.521Z",
  "banner": "text",
  "link": "https://example.com",
  "requires_check_in": true,
  "requires_registration": true,
  "is_recurring": true,
  "is_livestream": true,
  "recurrence": "daily",
  "recurrence_days": null,
  "recurrence_custom_pattern": "text",
  "recurrence_end_date": "2025-07-23",
  "images": null,
  "location_type": "text"
}
put
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this event.

Body
idstring · uuidRead-onlyRequired
locationall ofRead-onlyRequired
registeredstringRead-onlyRequired
checked_instringRead-onlyRequired
registrationsstringRead-onlyRequired
registration_countstringRead-onlyRequired
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyRequired
public_idstring · max: 7Optional
namestring · max: 255Required
descriptionstringRequired
start_timestring · date-timeRequired
end_timestring · date-timeRequired
bannerstring | nullableOptional
linkstring · uri | nullableOptional
requires_check_inbooleanOptional
requires_registrationbooleanOptional
is_recurringbooleanOptional
is_livestreambooleanOptional
recurrenceone of | nullableOptional
string · enumOptional
  • daily - Daily
  • weekly - Weekly
  • monthly - Monthly
  • custom - Custom
Possible values:
or
undefined · enumOptionalPossible values:
or
undefined · enumOptionalPossible values:
recurrence_daysany | nullableOptional
recurrence_custom_patternstring | nullableOptional
recurrence_end_datestring · date | nullableOptional
imagesanyOptional
location_typestring | nullableOptional
Responses
200Success
application/json
put
PUT /api/events/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 510

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:16:47.521Z",
  "public_id": "text",
  "name": "text",
  "description": "text",
  "start_time": "2025-07-23T12:16:47.521Z",
  "end_time": "2025-07-23T12:16:47.521Z",
  "banner": "text",
  "link": "https://example.com",
  "requires_check_in": true,
  "requires_registration": true,
  "is_recurring": true,
  "is_livestream": true,
  "recurrence": "daily",
  "recurrence_days": null,
  "recurrence_custom_pattern": "text",
  "recurrence_end_date": "2025-07-23",
  "images": null,
  "location_type": "text"
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "location": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "legacy_id": "text",
    "nextgen_legacy_id": "text",
    "created_at": "2025-07-23T12:16:47.521Z",
    "updated_at": "2025-07-23T12:16:47.521Z",
    "name": "text",
    "address_1": "text",
    "address_2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text",
    "is_default": true,
    "is_main": true,
    "church": "123e4567-e89b-12d3-a456-426614174000"
  },
  "rsvps": [
    {
      "id": "text",
      "email": "text",
      "phone": "text",
      "profile": "text",
      "additional_user_fields": "text"
    }
  ],
  "registered": "text",
  "checked_in": "text",
  "registrations": "text",
  "registration_count": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:16:47.521Z",
  "updated_at": "2025-07-23T12:16:47.521Z",
  "public_id": "text",
  "name": "text",
  "description": "text",
  "start_time": "2025-07-23T12:16:47.521Z",
  "end_time": "2025-07-23T12:16:47.521Z",
  "banner": "text",
  "link": "https://example.com",
  "requires_check_in": true,
  "requires_registration": true,
  "is_recurring": true,
  "is_livestream": true,
  "recurrence": "daily",
  "recurrence_days": null,
  "recurrence_custom_pattern": "text",
  "recurrence_end_date": "2025-07-23",
  "images": null,
  "location_type": "text"
}
delete
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this event.

Responses
204
No response body
delete
DELETE /api/events/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
204

No response body

No content
patch
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this event.

Body
idstring · uuidRead-onlyOptional
locationall ofRead-onlyOptional
registeredstringRead-onlyOptional
checked_instringRead-onlyOptional
registrationsstringRead-onlyOptional
registration_countstringRead-onlyOptional
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyOptional
public_idstring · max: 7Optional
namestring · max: 255Optional
descriptionstringOptional
start_timestring · date-timeOptional
end_timestring · date-timeOptional
bannerstring | nullableOptional
linkstring · uri | nullableOptional
requires_check_inbooleanOptional
requires_registrationbooleanOptional
is_recurringbooleanOptional
is_livestreambooleanOptional
recurrenceone of | nullableOptional
string · enumOptional
  • daily - Daily
  • weekly - Weekly
  • monthly - Monthly
  • custom - Custom
Possible values:
or
undefined · enumOptionalPossible values:
or
undefined · enumOptionalPossible values:
recurrence_daysany | nullableOptional
recurrence_custom_patternstring | nullableOptional
recurrence_end_datestring · date | nullableOptional
imagesanyOptional
location_typestring | nullableOptional
Responses
200Success
application/json
patch
PATCH /api/events/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 510

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:16:47.521Z",
  "public_id": "text",
  "name": "text",
  "description": "text",
  "start_time": "2025-07-23T12:16:47.521Z",
  "end_time": "2025-07-23T12:16:47.521Z",
  "banner": "text",
  "link": "https://example.com",
  "requires_check_in": true,
  "requires_registration": true,
  "is_recurring": true,
  "is_livestream": true,
  "recurrence": "daily",
  "recurrence_days": null,
  "recurrence_custom_pattern": "text",
  "recurrence_end_date": "2025-07-23",
  "images": null,
  "location_type": "text"
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "location": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "legacy_id": "text",
    "nextgen_legacy_id": "text",
    "created_at": "2025-07-23T12:16:47.521Z",
    "updated_at": "2025-07-23T12:16:47.521Z",
    "name": "text",
    "address_1": "text",
    "address_2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text",
    "is_default": true,
    "is_main": true,
    "church": "123e4567-e89b-12d3-a456-426614174000"
  },
  "rsvps": [
    {
      "id": "text",
      "email": "text",
      "phone": "text",
      "profile": "text",
      "additional_user_fields": "text"
    }
  ],
  "registered": "text",
  "checked_in": "text",
  "registrations": "text",
  "registration_count": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:16:47.521Z",
  "updated_at": "2025-07-23T12:16:47.521Z",
  "public_id": "text",
  "name": "text",
  "description": "text",
  "start_time": "2025-07-23T12:16:47.521Z",
  "end_time": "2025-07-23T12:16:47.521Z",
  "banner": "text",
  "link": "https://example.com",
  "requires_check_in": true,
  "requires_registration": true,
  "is_recurring": true,
  "is_livestream": true,
  "recurrence": "daily",
  "recurrence_days": null,
  "recurrence_custom_pattern": "text",
  "recurrence_end_date": "2025-07-23",
  "images": null,
  "location_type": "text"
}
PreviousRequestsNextRegistrations