Members

Member management operations

Get members with filtering and pagination

get

https://api.example.com/v1https://staging-api.example.com/v1

/member

Retrieve members with optional filtering and pagination

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · min: 1Optional

Page number for pagination

Example: 1

limitinteger · min: 1 · max: 100Optional

Number of items per page

Example: 10

searchstringOptional

Search term for member name or email

statusstring · enumOptional

Filter by member status

Possible values:

approvalStatusstring · enumOptional

Filter by approval status

Possible values:

Responses

200

Members retrieved successfully

application/json

500

Internal server error

application/json

get

/member

HTTPcURLJavaScriptPython

GET /v1/member HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "pagination": {
    "currentPage": 1,
    "totalPages": 10,
    "totalItems": 100,
    "itemsPerPage": 10,
    "hasNextPage": true,
    "hasPreviousPage": false
  },
  "data": [
    {
      "memberId": "123e4567-e89b-12d3-a456-426614174000",
      "email": "[email protected]",
      "fullName": "text",
      "memberCode": "text",
      "title": "text",
      "gender": "text",
      "occupation": "text",
      "icNo": "text",
      "dateOfBirth": "2025-12-16",
      "race": "text",
      "address1": "text",
      "postcode": "text",
      "state": "text",
      "phoneNo": "text",
      "status": "active",
      "approvalStatus": "pending",
      "firstApprovalBy": "text",
      "secondApprovalBy": "text",
      "firstApprovalDate": "2025-12-16",
      "secondApprovalDate": "2025-12-16",
      "rejectionBy": "text",
      "rejectionDate": "2025-12-16",
      "memberSignPDFURL": "https://example.com",
      "sessionId": "text",
      "createdBy": "text",
      "updatedBy": "text",
      "createdAt": "2025-12-16T02:58:42.581Z",
      "updatedAt": "2025-12-16T02:58:42.581Z",
      "proveOfMembership": {
        "memberState": "text",
        "area": "text",
        "section": "text",
        "membershipType": "text",
        "dateOfIssue": "2025-12-16",
        "position": "text",
        "rankMarking": "text",
        "dateOfAssignment": "2025-12-16"
      }
    }
  ]
}

Register new member

post

https://api.example.com/v1https://staging-api.example.com/v1

/member/register

Register a new member with validation and role assignment

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

emailstring · emailRequired

Member's email address

passwordstringRequired

Member's password

fullNamestringRequired

Member's full name

memberCodestringRequired

Member code

titlestringRequired

Member title

genderstringRequired

Member's gender

occupationstringRequired

Member's occupation

icNostringRequired

IC number

dateOfBirthstring · dateRequired

Date of birth

racestringRequired

Member's race

address1stringRequired

Address line 1

postcodestringRequired

Postcode

statestringRequired

State

phoneNostringRequired

Phone number

memberStatestringRequired

Member state

areastringRequired

Area

sectionstringRequired

Section

membershipTypestringRequired

Membership type

dateOfIssuestring · dateRequired

Date of issue

positionstringRequired

Position

rankMarkingstringRequired

Rank marking

dateOfAssignmentstring · dateRequired

Date of assignment

Responses

200

Member registered successfully

application/json

400

Validation error or duplicate entry

application/json

500

Internal server error

application/json

post

/member/register

HTTPcURLJavaScriptPython

POST /v1/member/register HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 430

{
  "email": "[email protected]",
  "password": "text",
  "fullName": "text",
  "memberCode": "text",
  "title": "text",
  "gender": "text",
  "occupation": "text",
  "icNo": "text",
  "dateOfBirth": "2025-12-16",
  "race": "text",
  "address1": "text",
  "postcode": "text",
  "state": "text",
  "phoneNo": "text",
  "memberState": "text",
  "area": "text",
  "section": "text",
  "membershipType": "text",
  "dateOfIssue": "2025-12-16",
  "position": "text",
  "rankMarking": "text",
  "dateOfAssignment": "2025-12-16"
}

{
  "success": true,
  "message": "Member registered successfully",
  "data": {
    "memberId": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "fullName": "text",
    "memberCode": "text",
    "title": "text",
    "gender": "text",
    "occupation": "text",
    "icNo": "text",
    "dateOfBirth": "2025-12-16",
    "race": "text",
    "address1": "text",
    "postcode": "text",
    "state": "text",
    "phoneNo": "text",
    "status": "active",
    "approvalStatus": "pending",
    "firstApprovalBy": "text",
    "secondApprovalBy": "text",
    "firstApprovalDate": "2025-12-16",
    "secondApprovalDate": "2025-12-16",
    "rejectionBy": "text",
    "rejectionDate": "2025-12-16",
    "memberSignPDFURL": "https://example.com",
    "sessionId": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "createdAt": "2025-12-16T02:58:42.581Z",
    "updatedAt": "2025-12-16T02:58:42.581Z",
    "proveOfMembership": {
      "memberState": "text",
      "area": "text",
      "section": "text",
      "membershipType": "text",
      "dateOfIssue": "2025-12-16",
      "position": "text",
      "rankMarking": "text",
      "dateOfAssignment": "2025-12-16"
    }
  }
}

Verify member registration

post

https://api.example.com/v1https://staging-api.example.com/v1

/member/verify

Verify member registration using token

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

tokenstringRequired

Registration verification token

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Responses

200

Member verified successfully

application/json

400

Token required

application/json

401

Invalid or expired token

application/json

post

/member/verify

HTTPcURLJavaScriptPython

POST /v1/member/verify HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

{
  "success": true,
  "message": "Member verified successfully"
}

Update member

put

https://api.example.com/v1https://staging-api.example.com/v1

/member/{memberId}

Update member information

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

memberIdstring · uuidRequired

Member ID

Body

application/json

emailstring · emailOptional

Member's email address

fullNamestringOptional

Member's full name

memberCodestringOptional

Member code

titlestringOptional

Member title

genderstringOptional

Member's gender

occupationstringOptional

Member's occupation

icNostringOptional

IC number

dateOfBirthstring · dateOptional

Date of birth

racestringOptional

Member's race

address1stringOptional

Address line 1

postcodestringOptional

Postcode

statestringOptional

State

phoneNostringOptional

Phone number

statusstring · enumOptional

Member status

Possible values:

approvalStatusstring · enumOptional

Approval status

Possible values:

firstApprovalBystringOptional

First approval by

secondApprovalBystringOptional

Second approval by

firstApprovalDatestring · dateOptional

First approval date

secondApprovalDatestring · dateOptional

Second approval date

rejectionBystringOptional

Rejection by

rejectionDatestring · dateOptional

Rejection date

memberSignPDFURLstring · uriOptional

Member signature PDF URL

sessionIdstringOptional

Session identifier

updatedBystringOptional

Updated by

Responses

200

Member updated successfully

application/json

400

Validation error or phone number exists

application/json

500

Internal server error

application/json

put

/member/{memberId}

HTTPcURLJavaScriptPython

PUT /v1/member/{memberId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 530

{
  "email": "[email protected]",
  "fullName": "text",
  "memberCode": "text",
  "title": "text",
  "gender": "text",
  "occupation": "text",
  "icNo": "text",
  "dateOfBirth": "2025-12-16",
  "race": "text",
  "address1": "text",
  "postcode": "text",
  "state": "text",
  "phoneNo": "text",
  "status": "active",
  "approvalStatus": "pending",
  "firstApprovalBy": "text",
  "secondApprovalBy": "text",
  "firstApprovalDate": "2025-12-16",
  "secondApprovalDate": "2025-12-16",
  "rejectionBy": "text",
  "rejectionDate": "2025-12-16",
  "memberSignPDFURL": "https://example.com",
  "sessionId": "text",
  "updatedBy": "text"
}

{
  "success": true,
  "message": "Member updated successfully",
  "data": {
    "memberId": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "fullName": "text",
    "memberCode": "text",
    "title": "text",
    "gender": "text",
    "occupation": "text",
    "icNo": "text",
    "dateOfBirth": "2025-12-16",
    "race": "text",
    "address1": "text",
    "postcode": "text",
    "state": "text",
    "phoneNo": "text",
    "status": "active",
    "approvalStatus": "pending",
    "firstApprovalBy": "text",
    "secondApprovalBy": "text",
    "firstApprovalDate": "2025-12-16",
    "secondApprovalDate": "2025-12-16",
    "rejectionBy": "text",
    "rejectionDate": "2025-12-16",
    "memberSignPDFURL": "https://example.com",
    "sessionId": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "createdAt": "2025-12-16T02:58:42.581Z",
    "updatedAt": "2025-12-16T02:58:42.581Z",
    "proveOfMembership": {
      "memberState": "text",
      "area": "text",
      "section": "text",
      "membershipType": "text",
      "dateOfIssue": "2025-12-16",
      "position": "text",
      "rankMarking": "text",
      "dateOfAssignment": "2025-12-16"
    }
  }
}

Update member password

put

https://api.example.com/v1https://staging-api.example.com/v1

/member/update-password

Update member password using current password

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

currentPasswordstringRequired

Current password

Example: oldPassword123

passwordstringRequired

New password

Example: newPassword123

confirmPasswordstringRequired

Confirm new password

Example: newPassword123

Responses

200

Password updated successfully

application/json

400

Invalid request or passwords don't match

application/json

401

Invalid current password or unauthorized

application/json

500

Internal server error

application/json

put

/member/update-password

HTTPcURLJavaScriptPython

PUT /v1/member/update-password HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "currentPassword": "oldPassword123",
  "password": "newPassword123",
  "confirmPassword": "newPassword123"
}

{
  "success": true,
  "message": "Password updated successfully"
}

Get current member

get

https://api.example.com/v1https://staging-api.example.com/v1

/member/self

Get current member information from token

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Member retrieved successfully

application/json

401

Unauthorized access

application/json

500

Internal server error

application/json

get

/member/self

HTTPcURLJavaScriptPython

GET /v1/member/self HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Member retrieved successfully",
  "data": {
    "memberId": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "fullName": "text",
    "memberCode": "text",
    "title": "text",
    "gender": "text",
    "occupation": "text",
    "icNo": "text",
    "dateOfBirth": "2025-12-16",
    "race": "text",
    "address1": "text",
    "postcode": "text",
    "state": "text",
    "phoneNo": "text",
    "status": "active",
    "approvalStatus": "pending",
    "firstApprovalBy": "text",
    "secondApprovalBy": "text",
    "firstApprovalDate": "2025-12-16",
    "secondApprovalDate": "2025-12-16",
    "rejectionBy": "text",
    "rejectionDate": "2025-12-16",
    "memberSignPDFURL": "https://example.com",
    "sessionId": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "createdAt": "2025-12-16T02:58:42.581Z",
    "updatedAt": "2025-12-16T02:58:42.581Z",
    "proveOfMembership": {
      "memberState": "text",
      "area": "text",
      "section": "text",
      "membershipType": "text",
      "dateOfIssue": "2025-12-16",
      "position": "text",
      "rankMarking": "text",
      "dateOfAssignment": "2025-12-16"
    }
  }
}

Approve member

post

https://api.example.com/v1https://staging-api.example.com/v1

/member/{memberId}/approve

Approve member registration (requires authorization)

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

memberIdstring · uuidRequired

Member ID to approve

Body

application/json

memberCodestringOptional

New member code for second approval

Example: M001

Responses

200

Member approved successfully

application/json

400

Invalid request or already approved

application/json

401

Unauthorized access

application/json

409

Duplicate member code

application/json

500

Internal server error

application/json

post

/member/{memberId}/approve

HTTPcURLJavaScriptPython

POST /v1/member/{memberId}/approve HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "memberCode": "M001"
}

{
  "success": true,
  "message": "Member approved successfully",
  "data": {
    "memberId": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "fullName": "text",
    "memberCode": "text",
    "title": "text",
    "gender": "text",
    "occupation": "text",
    "icNo": "text",
    "dateOfBirth": "2025-12-16",
    "race": "text",
    "address1": "text",
    "postcode": "text",
    "state": "text",
    "phoneNo": "text",
    "status": "active",
    "approvalStatus": "pending",
    "firstApprovalBy": "text",
    "secondApprovalBy": "text",
    "firstApprovalDate": "2025-12-16",
    "secondApprovalDate": "2025-12-16",
    "rejectionBy": "text",
    "rejectionDate": "2025-12-16",
    "memberSignPDFURL": "https://example.com",
    "sessionId": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "createdAt": "2025-12-16T02:58:42.581Z",
    "updatedAt": "2025-12-16T02:58:42.581Z",
    "proveOfMembership": {
      "memberState": "text",
      "area": "text",
      "section": "text",
      "membershipType": "text",
      "dateOfIssue": "2025-12-16",
      "position": "text",
      "rankMarking": "text",
      "dateOfAssignment": "2025-12-16"
    }
  }
}

Reject member

post

https://api.example.com/v1https://staging-api.example.com/v1

/member/{memberId}/reject

Reject member registration (requires authorization)

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

memberIdstring · uuidRequired

Member ID to reject

Responses

200

Member rejected successfully

application/json

400

Invalid request or already rejected

application/json

401

Unauthorized access

application/json

500

Internal server error

application/json

post

/member/{memberId}/reject

HTTPcURLJavaScriptPython

POST /v1/member/{memberId}/reject HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Member rejected successfully",
  "data": {
    "memberId": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "fullName": "text",
    "memberCode": "text",
    "title": "text",
    "gender": "text",
    "occupation": "text",
    "icNo": "text",
    "dateOfBirth": "2025-12-16",
    "race": "text",
    "address1": "text",
    "postcode": "text",
    "state": "text",
    "phoneNo": "text",
    "status": "active",
    "approvalStatus": "pending",
    "firstApprovalBy": "text",
    "secondApprovalBy": "text",
    "firstApprovalDate": "2025-12-16",
    "secondApprovalDate": "2025-12-16",
    "rejectionBy": "text",
    "rejectionDate": "2025-12-16",
    "memberSignPDFURL": "https://example.com",
    "sessionId": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "createdAt": "2025-12-16T02:58:42.581Z",
    "updatedAt": "2025-12-16T02:58:42.581Z",
    "proveOfMembership": {
      "memberState": "text",
      "area": "text",
      "section": "text",
      "membershipType": "text",
      "dateOfIssue": "2025-12-16",
      "position": "text",
      "rankMarking": "text",
      "dateOfAssignment": "2025-12-16"
    }
  }
}

Send reset password email

post

https://api.example.com/v1https://staging-api.example.com/v1

/member/reset-password/email

Send reset password email to member

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

emailstring · emailRequired

Member's email address

Example: [email protected]

Responses

200

Reset password email sent

application/json

400

Email required

application/json

post

/member/reset-password/email

HTTPcURLJavaScriptPython

POST /v1/member/reset-password/email HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "email": "[email protected]"
}

{
  "success": true,
  "message": "If the email exists, a reset password link will be sent"
}

Reset password

post

https://api.example.com/v1https://staging-api.example.com/v1

/member/reset-password

Reset password using token

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

passwordstringRequired

New password

Example: newPassword123

tokenstringRequired

Reset password token

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Responses

200

Password reset successfully

application/json

400

Password and token required

application/json

401

Invalid or expired token

application/json

post

/member/reset-password

HTTPcURLJavaScriptPython

POST /v1/member/reset-password HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "password": "newPassword123",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

{
  "success": true,
  "message": "Password reset successfully"
}