Users{id}

get

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this user.

Responses

200Success

application/json

get

/api/users{id}

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "profile": "text",
  "additional_user_fields": "text",
  "last_login": "2026-02-17T03:19:21.988Z",
  "email": "[email protected]",
  "phone": "text",
  "role": "member",
  "has_2fa": true,
  "is_deleted": true,
  "deleted_at": "2026-02-17T03:19:21.988Z",
  "permissions": null,
  "login_attempts": 1,
  "api_key": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

put

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this user.

Body

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

idstring · uuidRead-onlyRequired

profilestringRead-onlyRequired

additional_user_fieldsstringRead-onlyRequired

last_loginstring · date-time · nullableOptional

emailstring · email · max: 254Required

phonestringRequired

rolestring · enumOptional

• member - Member
• admin - Basic Admin
• super_admin - Super Admin

Possible values:

has_2fabooleanOptional

is_deletedbooleanOptional

deleted_atstring · date-time · nullableOptional

permissionsanyOptional

login_attemptsinteger · min: -2147483648 · max: 2147483647Optional

api_keystring · max: 64 · nullableOptional

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

churchstring · uuidRequired

Responses

200Success

application/json

put

/api/users{id}

HTTPcURLJavaScriptPython

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

{
  "last_login": "2026-02-17T03:19:21.988Z",
  "email": "[email protected]",
  "phone": "text",
  "role": "member",
  "has_2fa": true,
  "is_deleted": true,
  "deleted_at": "2026-02-17T03:19:21.988Z",
  "permissions": null,
  "login_attempts": 1,
  "api_key": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "profile": "text",
  "additional_user_fields": "text",
  "last_login": "2026-02-17T03:19:21.988Z",
  "email": "[email protected]",
  "phone": "text",
  "role": "member",
  "has_2fa": true,
  "is_deleted": true,
  "deleted_at": "2026-02-17T03:19:21.988Z",
  "permissions": null,
  "login_attempts": 1,
  "api_key": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

delete

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this user.

Responses

204

No response body

delete

/api/users{id}

HTTPcURLJavaScriptPython

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

204

No response body

No content

patch

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this user.

Body

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

idstring · uuidRead-onlyOptional

profilestringRead-onlyOptional

additional_user_fieldsstringRead-onlyOptional

last_loginstring · date-time · nullableOptional

emailstring · email · max: 254Optional

phonestringOptional

rolestring · enumOptional

• member - Member
• admin - Basic Admin
• super_admin - Super Admin

Possible values:

has_2fabooleanOptional

is_deletedbooleanOptional

deleted_atstring · date-time · nullableOptional

permissionsanyOptional

login_attemptsinteger · min: -2147483648 · max: 2147483647Optional

api_keystring · max: 64 · nullableOptional

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

churchstring · uuidOptional

Responses

200Success

application/json

patch

/api/users{id}

HTTPcURLJavaScriptPython

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

{
  "last_login": "2026-02-17T03:19:21.988Z",
  "email": "[email protected]",
  "phone": "text",
  "role": "member",
  "has_2fa": true,
  "is_deleted": true,
  "deleted_at": "2026-02-17T03:19:21.988Z",
  "permissions": null,
  "login_attempts": 1,
  "api_key": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "profile": "text",
  "additional_user_fields": "text",
  "last_login": "2026-02-17T03:19:21.988Z",
  "email": "[email protected]",
  "phone": "text",
  "role": "member",
  "has_2fa": true,
  "is_deleted": true,
  "deleted_at": "2026-02-17T03:19:21.988Z",
  "permissions": null,
  "login_attempts": 1,
  "api_key": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}