Users

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
GET /api/users 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",
      "profile": "text",
      "additional_user_fields": "text",
      "last_login": "2025-07-23T12:16:38.072Z",
      "email": "[email protected]",
      "phone": "text",
      "role": "member",
      "has_2fa": true,
      "is_deleted": true,
      "deleted_at": "2025-07-23T12:16:38.072Z",
      "permissions": null,
      "login_attempts": 1,
      "api_key": "text",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}
post
Authorizations
Body
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 | nullableOptional
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
churchstring · uuidRequired
Responses
201Success
application/json
post
POST /api/users HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 319

{
  "last_login": "2025-07-23T12:16:38.072Z",
  "email": "[email protected]",
  "phone": "text",
  "role": "member",
  "has_2fa": true,
  "is_deleted": true,
  "deleted_at": "2025-07-23T12:16:38.072Z",
  "permissions": null,
  "login_attempts": 1,
  "api_key": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}
201Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "profile": "text",
  "additional_user_fields": "text",
  "last_login": "2025-07-23T12:16:38.072Z",
  "email": "[email protected]",
  "phone": "text",
  "role": "member",
  "has_2fa": true,
  "is_deleted": true,
  "deleted_at": "2025-07-23T12:16:38.072Z",
  "permissions": null,
  "login_attempts": 1,
  "api_key": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}
PreviousDeleteNextAdministrators