Locations

get
Authorizations
Query parameters
limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses
200Success
application/json
get
GET /api/church/locations HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:46:09.602Z",
      "updated_at": "2025-07-23T12:46:09.602Z",
      "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"
    }
  ]
}
post
Authorizations
Body
idstring · uuidRead-onlyRequired
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyRequired
namestring · max: 100Required
address_1stringRequired
address_2string | nullableOptional
citystringRequired
statestringRequired
zipstringRequired
countrystring | nullableOptional
is_defaultbooleanOptional
is_mainbooleanOptional
churchstring · uuidRequired
Responses
201Success
application/json
post
POST /api/church/locations HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 279

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:46:09.602Z",
  "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"
}
201Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:46:09.602Z",
  "updated_at": "2025-07-23T12:46:09.602Z",
  "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"
}
get
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this location.

Responses
200Success
application/json
get
GET /api/church/locations/{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:46:09.602Z",
  "updated_at": "2025-07-23T12:46:09.602Z",
  "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"
}
put
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this location.

Body
idstring · uuidRead-onlyRequired
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyRequired
namestring · max: 100Required
address_1stringRequired
address_2string | nullableOptional
citystringRequired
statestringRequired
zipstringRequired
countrystring | nullableOptional
is_defaultbooleanOptional
is_mainbooleanOptional
churchstring · uuidRequired
Responses
200Success
application/json
put
PUT /api/church/locations/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 279

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:46:09.602Z",
  "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"
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:46:09.602Z",
  "updated_at": "2025-07-23T12:46:09.602Z",
  "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"
}
delete
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this location.

Responses
204
No response body
delete
DELETE /api/church/locations/{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 location.

Body
idstring · uuidRead-onlyOptional
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyOptional
namestring · max: 100Optional
address_1stringOptional
address_2string | nullableOptional
citystringOptional
statestringOptional
zipstringOptional
countrystring | nullableOptional
is_defaultbooleanOptional
is_mainbooleanOptional
churchstring · uuidOptional
Responses
200Success
application/json
patch
PATCH /api/church/locations/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 279

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:46:09.602Z",
  "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"
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:46:09.602Z",
  "updated_at": "2025-07-23T12:46:09.602Z",
  "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"
}
PreviousPayment confirmationNextOnboarding