Appointments

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/users/appointments 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",
      "user": {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      },
      "leader": {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      },
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:48:43.453Z",
      "updated_at": "2025-07-23T12:48:43.453Z",
      "date": "2025-07-23",
      "time": "12:48:43",
      "type": "text",
      "status": "pending",
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

post

Authorizations

Body

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

idstring · uuidRead-onlyRequired

userall ofRead-onlyRequired

leaderall ofRead-onlyRequired

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyRequired

datestring · dateRequired

timestring · timeRequired

typestringRequired

statusstring · enumOptional

• pending - Pending
• accepted - Accepted
• rejected - Rejected
• rescheduled - Rescheduled

Possible values:

churchstring · uuidRequired

Responses

201Success

application/json

post

HTTPcURLJavaScriptPython

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

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:48:43.453Z",
  "date": "2025-07-23",
  "time": "12:48:43",
  "type": "text",
  "status": "pending",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

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

201Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "leader": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:48:43.453Z",
  "updated_at": "2025-07-23T12:48:43.453Z",
  "date": "2025-07-23",
  "time": "12:48:43",
  "type": "text",
  "status": "pending",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

get

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this appointment.

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "leader": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:48:43.453Z",
  "updated_at": "2025-07-23T12:48:43.453Z",
  "date": "2025-07-23",
  "time": "12:48:43",
  "type": "text",
  "status": "pending",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

put

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this appointment.

Body

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

idstring · uuidRead-onlyRequired

userall ofRead-onlyRequired

leaderall ofRead-onlyRequired

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyRequired

datestring · dateRequired

timestring · timeRequired

typestringRequired

statusstring · enumOptional

• pending - Pending
• accepted - Accepted
• rejected - Rejected
• rescheduled - Rescheduled

Possible values:

churchstring · uuidRequired

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

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

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:48:43.453Z",
  "date": "2025-07-23",
  "time": "12:48:43",
  "type": "text",
  "status": "pending",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "leader": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:48:43.453Z",
  "updated_at": "2025-07-23T12:48:43.453Z",
  "date": "2025-07-23",
  "time": "12:48:43",
  "type": "text",
  "status": "pending",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

delete

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this appointment.

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

DELETE /api/users/appointments/{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 appointment.

Body

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

idstring · uuidRead-onlyOptional

userall ofRead-onlyOptional

leaderall ofRead-onlyOptional

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyOptional

datestring · dateOptional

timestring · timeOptional

typestringOptional

statusstring · enumOptional

• pending - Pending
• accepted - Accepted
• rejected - Rejected
• rescheduled - Rescheduled

Possible values:

churchstring · uuidOptional

Responses

200Success

application/json

patch

HTTPcURLJavaScriptPython

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

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:48:43.453Z",
  "date": "2025-07-23",
  "time": "12:48:43",
  "type": "text",
  "status": "pending",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "leader": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:48:43.453Z",
  "updated_at": "2025-07-23T12:48:43.453Z",
  "date": "2025-07-23",
  "time": "12:48:43",
  "type": "text",
  "status": "pending",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}