Overview

get

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

get

/api/users/overview

HTTPcURLJavaScriptPython

GET /api/users/overview 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-17T05:09:41.873Z",
  "email": "[email protected]",
  "phone": "text",
  "role": "member",
  "has_2fa": true,
  "is_deleted": true,
  "deleted_at": "2026-02-17T05:09:41.873Z",
  "permissions": null,
  "login_attempts": 1,
  "api_key": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

get

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

route_actionstringRequiredPattern: ^(genders|marital-statuses|membership-types|age-groups|birthdays|anniversaries|children)$

Responses

200Success

application/json

get

/api/users/overview/{route_action}

HTTPcURLJavaScriptPython

GET /api/users/overview/{route_action} 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-17T05:09:41.873Z",
  "email": "[email protected]",
  "phone": "text",
  "role": "member",
  "has_2fa": true,
  "is_deleted": true,
  "deleted_at": "2026-02-17T05:09:41.873Z",
  "permissions": null,
  "login_attempts": 1,
  "api_key": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}