Locations

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses
chevron-right
200Success
application/json
get
/api/church/locations
200Success
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
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
post
/api/church/locations
201Success
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this location.

Responses
chevron-right
200Success
application/json
get
/api/church/locations/{id}
200Success
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
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
chevron-right
200Success
application/json
put
/api/church/locations/{id}
200Success
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this location.

Responses
delete
/api/church/locations/{id}
204

No response body

No content

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
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
chevron-right
200Success
application/json
patch
/api/church/locations/{id}
200Success