Forms

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

HTTPcURLJavaScriptPython

GET /api/forms 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",
      "questions": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "form": "123e4567-e89b-12d3-a456-426614174000",
          "legacy_id": "text",
          "nextgen_legacy_id": "text",
          "created_at": "2025-07-23T12:14:56.764Z",
          "updated_at": "2025-07-23T12:14:56.764Z",
          "text": "text",
          "type": "short_answer",
          "options": null,
          "is_required": true,
          "position": 0
        }
      ],
      "user": {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      },
      "submission_count": "text",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:14:56.764Z",
      "updated_at": "2025-07-23T12:14:56.764Z",
      "name": "text",
      "description": "text",
      "banner": "https://example.com",
      "status": "waiting",
      "type": "public",
      "start_date": "2025-07-23",
      "end_date": "2025-07-23",
      "is_new_here_form": true,
      "is_plan_a_visit_form": true,
      "church": "123e4567-e89b-12d3-a456-426614174000",
      "notify_users": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

post

Authorizations

Body

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

idstring · uuidRead-onlyRequired

userall ofRead-onlyRequired

submission_countstringRead-onlyRequired

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyRequired

namestring · max: 255Required

descriptionstring | nullableOptional

bannerstring · uri | nullableOptional

statusstring · enumOptional

• waiting - Waiting
• active - Active
• expired - Expired
• disabled - Disabled

Possible values:

typestring · enumOptional

• public - Public
• private - Private

Possible values:

start_datestring · date | nullableOptional

end_datestring · date | nullableOptional

is_new_here_formbooleanOptional

is_plan_a_visit_formbooleanOptional

churchstring · uuidRequired

notify_usersstring · uuid[]Required

Responses

201Success

application/json

post

HTTPcURLJavaScriptPython

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

{
  "questions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:14:56.764Z",
      "text": "text",
      "type": "short_answer",
      "options": null,
      "is_required": true,
      "position": 0
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:14:56.764Z",
  "name": "text",
  "description": "text",
  "banner": "https://example.com",
  "status": "waiting",
  "type": "public",
  "start_date": "2025-07-23",
  "end_date": "2025-07-23",
  "is_new_here_form": true,
  "is_plan_a_visit_form": true,
  "church": "123e4567-e89b-12d3-a456-426614174000",
  "notify_users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

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

201Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "questions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "form": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:14:56.764Z",
      "updated_at": "2025-07-23T12:14:56.764Z",
      "text": "text",
      "type": "short_answer",
      "options": null,
      "is_required": true,
      "position": 0
    }
  ],
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "submission_count": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:14:56.764Z",
  "updated_at": "2025-07-23T12:14:56.764Z",
  "name": "text",
  "description": "text",
  "banner": "https://example.com",
  "status": "waiting",
  "type": "public",
  "start_date": "2025-07-23",
  "end_date": "2025-07-23",
  "is_new_here_form": true,
  "is_plan_a_visit_form": true,
  "church": "123e4567-e89b-12d3-a456-426614174000",
  "notify_users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

get

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this form.

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "questions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "form": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:14:56.764Z",
      "updated_at": "2025-07-23T12:14:56.764Z",
      "text": "text",
      "type": "short_answer",
      "options": null,
      "is_required": true,
      "position": 0
    }
  ],
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "submission_count": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:14:56.764Z",
  "updated_at": "2025-07-23T12:14:56.764Z",
  "name": "text",
  "description": "text",
  "banner": "https://example.com",
  "status": "waiting",
  "type": "public",
  "start_date": "2025-07-23",
  "end_date": "2025-07-23",
  "is_new_here_form": true,
  "is_plan_a_visit_form": true,
  "church": "123e4567-e89b-12d3-a456-426614174000",
  "notify_users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

put

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this form.

Body

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

idstring · uuidRead-onlyRequired

userall ofRead-onlyRequired

submission_countstringRead-onlyRequired

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyRequired

namestring · max: 255Required

descriptionstring | nullableOptional

bannerstring · uri | nullableOptional

statusstring · enumOptional

• waiting - Waiting
• active - Active
• expired - Expired
• disabled - Disabled

Possible values:

typestring · enumOptional

• public - Public
• private - Private

Possible values:

start_datestring · date | nullableOptional

end_datestring · date | nullableOptional

is_new_here_formbooleanOptional

is_plan_a_visit_formbooleanOptional

churchstring · uuidRequired

notify_usersstring · uuid[]Required

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

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

{
  "questions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:14:56.764Z",
      "text": "text",
      "type": "short_answer",
      "options": null,
      "is_required": true,
      "position": 0
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:14:56.764Z",
  "name": "text",
  "description": "text",
  "banner": "https://example.com",
  "status": "waiting",
  "type": "public",
  "start_date": "2025-07-23",
  "end_date": "2025-07-23",
  "is_new_here_form": true,
  "is_plan_a_visit_form": true,
  "church": "123e4567-e89b-12d3-a456-426614174000",
  "notify_users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "questions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "form": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:14:56.764Z",
      "updated_at": "2025-07-23T12:14:56.764Z",
      "text": "text",
      "type": "short_answer",
      "options": null,
      "is_required": true,
      "position": 0
    }
  ],
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "submission_count": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:14:56.764Z",
  "updated_at": "2025-07-23T12:14:56.764Z",
  "name": "text",
  "description": "text",
  "banner": "https://example.com",
  "status": "waiting",
  "type": "public",
  "start_date": "2025-07-23",
  "end_date": "2025-07-23",
  "is_new_here_form": true,
  "is_plan_a_visit_form": true,
  "church": "123e4567-e89b-12d3-a456-426614174000",
  "notify_users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

delete

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this form.

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

DELETE /api/forms/{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 form.

Body

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

idstring · uuidRead-onlyOptional

userall ofRead-onlyOptional

submission_countstringRead-onlyOptional

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyOptional

namestring · max: 255Optional

descriptionstring | nullableOptional

bannerstring · uri | nullableOptional

statusstring · enumOptional

• waiting - Waiting
• active - Active
• expired - Expired
• disabled - Disabled

Possible values:

typestring · enumOptional

• public - Public
• private - Private

Possible values:

start_datestring · date | nullableOptional

end_datestring · date | nullableOptional

is_new_here_formbooleanOptional

is_plan_a_visit_formbooleanOptional

churchstring · uuidOptional

notify_usersstring · uuid[]Optional

Responses

200Success

application/json

patch

HTTPcURLJavaScriptPython

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

{
  "questions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:14:56.764Z",
      "text": "text",
      "type": "short_answer",
      "options": null,
      "is_required": true,
      "position": 0
    }
  ],
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:14:56.764Z",
  "name": "text",
  "description": "text",
  "banner": "https://example.com",
  "status": "waiting",
  "type": "public",
  "start_date": "2025-07-23",
  "end_date": "2025-07-23",
  "is_new_here_form": true,
  "is_plan_a_visit_form": true,
  "church": "123e4567-e89b-12d3-a456-426614174000",
  "notify_users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "questions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "form": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:14:56.764Z",
      "updated_at": "2025-07-23T12:14:56.764Z",
      "text": "text",
      "type": "short_answer",
      "options": null,
      "is_required": true,
      "position": 0
    }
  ],
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "submission_count": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:14:56.764Z",
  "updated_at": "2025-07-23T12:14:56.764Z",
  "name": "text",
  "description": "text",
  "banner": "https://example.com",
  "status": "waiting",
  "type": "public",
  "start_date": "2025-07-23",
  "end_date": "2025-07-23",
  "is_new_here_form": true,
  "is_plan_a_visit_form": true,
  "church": "123e4567-e89b-12d3-a456-426614174000",
  "notify_users": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}