Skip to main content
Use this endpoint to retrieve a list of all team members associated with your Shogun account. You can optionally filter the results by date range, sort by a specific field, and paginate through large member lists. Each record in the response includes the member’s identity, role assignment, and activation status.

Endpoint

POST /api/v1/auth/web/fetch_members

Authentication

This endpoint requires a valid Dashboard JWT. Pass the token in the Authorization header:
Authorization: Bearer <access_token>

Request Body

All fields are optional. Send an empty JSON object {} to retrieve all members.
filters
object
An object of filter fields to narrow results.
sort_by
string
The field to sort results by (e.g. date_joined, email).
sort_order
string
Sort direction. Use asc for ascending or desc for descending.
page
integer
Page number for paginated results. Defaults to 1.
page_size
integer
Number of members to return per page. Defaults to 20.

Response

{
  "status": true,
  "response_code": "00",
  "message": "Team members fetched successfully",
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "email": "jane.doe@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "user_role_id": "r1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "is_active": true,
      "last_login": "2026-04-15T09:30:00Z",
      "date_joined": "2026-01-10T08:00:00Z"
    }
  ]
}
FieldTypeDescription
idUUIDUnique identifier for the team member
emailstringEmail address of the team member
first_namestringMember’s first name
last_namestringMember’s last name
user_role_idUUIDID of the role currently assigned to the member
is_activebooleanWhether the member’s account is currently active
last_logindatetimeTimestamp of the member’s most recent login
date_joineddatetimeTimestamp of when the member joined the account

Example

curl -X POST https://baasapi.payrepmfb.com/api/v1/auth/web/fetch_members \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "filters": {
      "start_date": "2026-01-01",
      "end_date": "2026-04-01"
    },
    "sort_by": "date_joined",
    "sort_order": "desc",
    "page": 1,
    "page_size": 20
  }'