Departments

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

HTTPcURLJavaScriptPython

GET /api/departments 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",
      "meeting_times": [
        {
          "type": "virtual",
          "day": "Monday",
          "start_time": "21:41:25",
          "end_time": "21:41:25"
        }
      ],
      "is_member": "text",
      "is_leader": "text",
      "has_pending_request": "text",
      "member_count": "text",
      "leaders": "text",
      "members": "text",
      "pending_request_count": "text",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-22T21:41:25.379Z",
      "updated_at": "2025-07-22T21:41:25.379Z",
      "name": "text",
      "description": "text",
      "banner": "https://example.com",
      "is_follow_up_department": true
    }
  ]
}

post

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idstring · uuidRead-onlyRequired

is_memberstringRead-onlyRequired

is_leaderstringRead-onlyRequired

has_pending_requeststringRead-onlyRequired

member_countstringRead-onlyRequired

leadersstringRead-onlyRequired

membersstringRead-onlyRequired

pending_request_countstringRead-onlyRequired

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyRequired

namestring · max: 255Required

descriptionstringRequired

bannerstring · uri | nullableOptional

is_follow_up_departmentbooleanOptional

Responses

201Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/departments HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "meeting_times": [
    {
      "type": "virtual",
      "day": "Monday",
      "start_time": "21:41:25",
      "end_time": "21:41:25"
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-22T21:41:25.379Z",
  "name": "text",
  "description": "text",
  "banner": "https://example.com",
  "is_follow_up_department": true
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "meeting_times": [
    {
      "type": "virtual",
      "day": "Monday",
      "start_time": "21:41:25",
      "end_time": "21:41:25"
    }
  ],
  "is_member": "text",
  "is_leader": "text",
  "has_pending_request": "text",
  "member_count": "text",
  "leaders": "text",
  "members": "text",
  "pending_request_count": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-22T21:41:25.379Z",
  "updated_at": "2025-07-22T21:41:25.379Z",
  "name": "text",
  "description": "text",
  "banner": "https://example.com",
  "is_follow_up_department": true
}

get

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this group.

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/departments/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "meeting_times": [
    {
      "type": "virtual",
      "day": "Monday",
      "start_time": "21:41:25",
      "end_time": "21:41:25"
    }
  ],
  "is_member": "text",
  "is_leader": "text",
  "has_pending_request": "text",
  "member_count": "text",
  "leaders": "text",
  "members": "text",
  "pending_request_count": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-22T21:41:25.379Z",
  "updated_at": "2025-07-22T21:41:25.379Z",
  "name": "text",
  "description": "text",
  "banner": "https://example.com",
  "is_follow_up_department": true
}

put

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this group.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idstring · uuidRead-onlyRequired

is_memberstringRead-onlyRequired

is_leaderstringRead-onlyRequired

has_pending_requeststringRead-onlyRequired

member_countstringRead-onlyRequired

leadersstringRead-onlyRequired

membersstringRead-onlyRequired

pending_request_countstringRead-onlyRequired

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyRequired

namestring · max: 255Required

descriptionstringRequired

bannerstring · uri | nullableOptional

is_follow_up_departmentbooleanOptional

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

PUT /api/departments/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "meeting_times": [
    {
      "type": "virtual",
      "day": "Monday",
      "start_time": "21:41:25",
      "end_time": "21:41:25"
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-22T21:41:25.379Z",
  "name": "text",
  "description": "text",
  "banner": "https://example.com",
  "is_follow_up_department": true
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "meeting_times": [
    {
      "type": "virtual",
      "day": "Monday",
      "start_time": "21:41:25",
      "end_time": "21:41:25"
    }
  ],
  "is_member": "text",
  "is_leader": "text",
  "has_pending_request": "text",
  "member_count": "text",
  "leaders": "text",
  "members": "text",
  "pending_request_count": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-22T21:41:25.379Z",
  "updated_at": "2025-07-22T21:41:25.379Z",
  "name": "text",
  "description": "text",
  "banner": "https://example.com",
  "is_follow_up_department": true
}

delete

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this group.

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

DELETE /api/departments/{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 group.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idstring · uuidRead-onlyOptional

is_memberstringRead-onlyOptional

is_leaderstringRead-onlyOptional

has_pending_requeststringRead-onlyOptional

member_countstringRead-onlyOptional

leadersstringRead-onlyOptional

membersstringRead-onlyOptional

pending_request_countstringRead-onlyOptional

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyOptional

namestring · max: 255Optional

descriptionstringOptional

bannerstring · uri | nullableOptional

is_follow_up_departmentbooleanOptional

Responses

200Success

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/departments/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "meeting_times": [
    {
      "type": "virtual",
      "day": "Monday",
      "start_time": "21:41:25",
      "end_time": "21:41:25"
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-22T21:41:25.379Z",
  "name": "text",
  "description": "text",
  "banner": "https://example.com",
  "is_follow_up_department": true
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "meeting_times": [
    {
      "type": "virtual",
      "day": "Monday",
      "start_time": "21:41:25",
      "end_time": "21:41:25"
    }
  ],
  "is_member": "text",
  "is_leader": "text",
  "has_pending_request": "text",
  "member_count": "text",
  "leaders": "text",
  "members": "text",
  "pending_request_count": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-22T21:41:25.379Z",
  "updated_at": "2025-07-22T21:41:25.379Z",
  "name": "text",
  "description": "text",
  "banner": "https://example.com",
  "is_follow_up_department": true
}