Users

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

/api/users

GET /api/users HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
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": "2026-02-17T02:50:53.846Z",
      "email": "[email protected]",
      "phone": "text",
      "role": "member",
      "has_2fa": true,
      "is_deleted": true,
      "deleted_at": "2026-02-17T02:50:53.846Z",
      "permissions": null,
      "login_attempts": 1,
      "api_key": "text",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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 · max: 64 · nullableOptional

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

churchstring · uuidRequired