Follow up
get
Authorizations
Query parameters
pageintegerOptional
A page number within the paginated result set.
page_sizeintegerOptional
Number of results to return per page.
Responses
200Success
application/json
get
GET /api/users/follow-up HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
200Success
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:50:13.246Z",
"updated_at": "2025-07-23T12:50:13.246Z",
"salutation": "text",
"first_name": "text",
"last_name": "text",
"full_name": "text",
"email": "[email protected]",
"phone": "text",
"call_time": "morning",
"gender": "male",
"address_1": "text",
"address_2": "text",
"city": "text",
"state": "text",
"zip": "text",
"request": "text",
"invite_type": "text",
"birth_date": "2025-07-23",
"age_group": "text",
"status": "text",
"activity_log": null,
"church": "123e4567-e89b-12d3-a456-426614174000",
"inviter": "123e4567-e89b-12d3-a456-426614174000",
"user": "123e4567-e89b-12d3-a456-426614174000"
}
]
}
post
Authorizations
Body
idstring · uuidRead-onlyRequired
assigned_userstring · uuidWrite-onlyOptional
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyRequired
salutationstring | nullableOptional
first_namestring · max: 100Required
last_namestring · max: 100Required
full_namestring | nullableRead-onlyRequired
emailstring · email | nullableOptional
phonestring | nullableOptional
call_timeone of | nullableOptional
string · enumOptionalPossible values:
morning
- Morning (9AM-12PM)evening
- Evening (5PM-8PM)afternoon
- Afternoon (1PM-4PM)others
- Other (Anytime between 9AM-8PM)
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
genderone of | nullableOptional
string · enumOptionalPossible values:
male
- Malefemale
- Female
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
address_1string | nullableOptional
address_2string | nullableOptional
citystring | nullableOptional
statestring | nullableOptional
zipstring | nullableOptional
requeststring | nullableOptional
invite_typestring | nullableOptional
birth_datestring · date | nullableOptional
age_groupstring | nullableOptional
statusstring | nullableOptional
activity_logany | nullableOptional
churchstring · uuidRequired
inviterstring · uuid | nullableOptional
userstring · uuid | nullableOptional
Responses
201Success
application/json
post
POST /api/users/follow-up HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 621
{
"assigned_user": "123e4567-e89b-12d3-a456-426614174000",
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:50:13.246Z",
"salutation": "text",
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"phone": "text",
"call_time": "morning",
"gender": "male",
"address_1": "text",
"address_2": "text",
"city": "text",
"state": "text",
"zip": "text",
"request": "text",
"invite_type": "text",
"birth_date": "2025-07-23",
"age_group": "text",
"status": "text",
"activity_log": null,
"church": "123e4567-e89b-12d3-a456-426614174000",
"inviter": "123e4567-e89b-12d3-a456-426614174000",
"user": "123e4567-e89b-12d3-a456-426614174000"
}
201Success
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:50:13.246Z",
"updated_at": "2025-07-23T12:50:13.246Z",
"salutation": "text",
"first_name": "text",
"last_name": "text",
"full_name": "text",
"email": "[email protected]",
"phone": "text",
"call_time": "morning",
"gender": "male",
"address_1": "text",
"address_2": "text",
"city": "text",
"state": "text",
"zip": "text",
"request": "text",
"invite_type": "text",
"birth_date": "2025-07-23",
"age_group": "text",
"status": "text",
"activity_log": null,
"church": "123e4567-e89b-12d3-a456-426614174000",
"inviter": "123e4567-e89b-12d3-a456-426614174000",
"user": "123e4567-e89b-12d3-a456-426614174000"
}
get
Authorizations
Path parameters
idstring · uuidRequired
A UUID string identifying this guest.
Responses
200Success
application/json
get
GET /api/users/follow-up/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
200Success
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:50:13.246Z",
"updated_at": "2025-07-23T12:50:13.246Z",
"salutation": "text",
"first_name": "text",
"last_name": "text",
"full_name": "text",
"email": "[email protected]",
"phone": "text",
"call_time": "morning",
"gender": "male",
"address_1": "text",
"address_2": "text",
"city": "text",
"state": "text",
"zip": "text",
"request": "text",
"invite_type": "text",
"birth_date": "2025-07-23",
"age_group": "text",
"status": "text",
"activity_log": null,
"church": "123e4567-e89b-12d3-a456-426614174000",
"inviter": "123e4567-e89b-12d3-a456-426614174000",
"user": "123e4567-e89b-12d3-a456-426614174000"
}
put
Authorizations
Path parameters
idstring · uuidRequired
A UUID string identifying this guest.
Body
idstring · uuidRead-onlyRequired
assigned_userstring · uuidWrite-onlyOptional
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyRequired
salutationstring | nullableOptional
first_namestring · max: 100Required
last_namestring · max: 100Required
full_namestring | nullableRead-onlyRequired
emailstring · email | nullableOptional
phonestring | nullableOptional
call_timeone of | nullableOptional
string · enumOptionalPossible values:
morning
- Morning (9AM-12PM)evening
- Evening (5PM-8PM)afternoon
- Afternoon (1PM-4PM)others
- Other (Anytime between 9AM-8PM)
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
genderone of | nullableOptional
string · enumOptionalPossible values:
male
- Malefemale
- Female
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
address_1string | nullableOptional
address_2string | nullableOptional
citystring | nullableOptional
statestring | nullableOptional
zipstring | nullableOptional
requeststring | nullableOptional
invite_typestring | nullableOptional
birth_datestring · date | nullableOptional
age_groupstring | nullableOptional
statusstring | nullableOptional
activity_logany | nullableOptional
churchstring · uuidRequired
inviterstring · uuid | nullableOptional
userstring · uuid | nullableOptional
Responses
200Success
application/json
put
PUT /api/users/follow-up/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 621
{
"assigned_user": "123e4567-e89b-12d3-a456-426614174000",
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:50:13.246Z",
"salutation": "text",
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"phone": "text",
"call_time": "morning",
"gender": "male",
"address_1": "text",
"address_2": "text",
"city": "text",
"state": "text",
"zip": "text",
"request": "text",
"invite_type": "text",
"birth_date": "2025-07-23",
"age_group": "text",
"status": "text",
"activity_log": null,
"church": "123e4567-e89b-12d3-a456-426614174000",
"inviter": "123e4567-e89b-12d3-a456-426614174000",
"user": "123e4567-e89b-12d3-a456-426614174000"
}
200Success
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:50:13.246Z",
"updated_at": "2025-07-23T12:50:13.246Z",
"salutation": "text",
"first_name": "text",
"last_name": "text",
"full_name": "text",
"email": "[email protected]",
"phone": "text",
"call_time": "morning",
"gender": "male",
"address_1": "text",
"address_2": "text",
"city": "text",
"state": "text",
"zip": "text",
"request": "text",
"invite_type": "text",
"birth_date": "2025-07-23",
"age_group": "text",
"status": "text",
"activity_log": null,
"church": "123e4567-e89b-12d3-a456-426614174000",
"inviter": "123e4567-e89b-12d3-a456-426614174000",
"user": "123e4567-e89b-12d3-a456-426614174000"
}
delete
Authorizations
Path parameters
idstring · uuidRequired
A UUID string identifying this guest.
Responses
204
No response body
delete
DELETE /api/users/follow-up/{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 guest.
Body
idstring · uuidRead-onlyOptional
assigned_userstring · uuidWrite-onlyOptional
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyOptional
salutationstring | nullableOptional
first_namestring · max: 100Optional
last_namestring · max: 100Optional
full_namestring | nullableRead-onlyOptional
emailstring · email | nullableOptional
phonestring | nullableOptional
call_timeone of | nullableOptional
string · enumOptionalPossible values:
morning
- Morning (9AM-12PM)evening
- Evening (5PM-8PM)afternoon
- Afternoon (1PM-4PM)others
- Other (Anytime between 9AM-8PM)
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
genderone of | nullableOptional
string · enumOptionalPossible values:
male
- Malefemale
- Female
undefined · enumOptionalPossible values:
undefined · enumOptionalPossible values:
address_1string | nullableOptional
address_2string | nullableOptional
citystring | nullableOptional
statestring | nullableOptional
zipstring | nullableOptional
requeststring | nullableOptional
invite_typestring | nullableOptional
birth_datestring · date | nullableOptional
age_groupstring | nullableOptional
statusstring | nullableOptional
activity_logany | nullableOptional
churchstring · uuidOptional
inviterstring · uuid | nullableOptional
userstring · uuid | nullableOptional
Responses
200Success
application/json
patch
PATCH /api/users/follow-up/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 621
{
"assigned_user": "123e4567-e89b-12d3-a456-426614174000",
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:50:13.246Z",
"salutation": "text",
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"phone": "text",
"call_time": "morning",
"gender": "male",
"address_1": "text",
"address_2": "text",
"city": "text",
"state": "text",
"zip": "text",
"request": "text",
"invite_type": "text",
"birth_date": "2025-07-23",
"age_group": "text",
"status": "text",
"activity_log": null,
"church": "123e4567-e89b-12d3-a456-426614174000",
"inviter": "123e4567-e89b-12d3-a456-426614174000",
"user": "123e4567-e89b-12d3-a456-426614174000"
}
200Success
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:50:13.246Z",
"updated_at": "2025-07-23T12:50:13.246Z",
"salutation": "text",
"first_name": "text",
"last_name": "text",
"full_name": "text",
"email": "[email protected]",
"phone": "text",
"call_time": "morning",
"gender": "male",
"address_1": "text",
"address_2": "text",
"city": "text",
"state": "text",
"zip": "text",
"request": "text",
"invite_type": "text",
"birth_date": "2025-07-23",
"age_group": "text",
"status": "text",
"activity_log": null,
"church": "123e4567-e89b-12d3-a456-426614174000",
"inviter": "123e4567-e89b-12d3-a456-426614174000",
"user": "123e4567-e89b-12d3-a456-426614174000"
}