Team Members

The Team Members controller manages team members within workspaces, including viewing, editing, and deleting team members, as well as handling invitations.

1. View All Team Members

GET /view-team-members/:workspaceId/:id

Request Parameters

• workspaceId: The ID of the workspace.
• id: The ID of the company or operator whose team members are being fetched.

Response

Status	Description
200 OK	Successfully fetched the list of team members in the workspace.
406 Not Acceptable	Invalid ID provided for either company or operator.
500 Internal Server Error	Failed to fetch the team members due to an unexpected error.

Response Object

{
    "teamMembers": [
        {
            "id": "string",
            "workspace_id": "string",
            "area": "string",
            "company_id": "string",
            "created_at": "string",
            "email": "string",
            "operator_id": "string",
            "partner_id": "string",
            "role": "string",
            "updated_at": "string",
            "user_id": "string"
        }
    ]
}

2. View Specific Team Member

GET /view-team-member/:workspaceId/:id/:memberId

Request Parameters

• workspaceId: The ID of the workspace.
• id: The ID of the company or operator.
• memberId: The ID of the team member to view.

Response

Status	Description
200 OK	Successfully fetched the specific team member details in the workspace.
406 Not Acceptable	Invalid ID provided for either company or operator.
500 Internal Server Error	Failed to fetch the team member details due to an unexpected error.

Response Object

{
    "teamMember": [
        {
            "id": "string",
            "workspace_id": "string",
            "area": "string",
            "company_id": "string",
            "created_at": "string",
            "email": "string",
            "operator_id": "string",
            "partner_id": "string",
            "role": "string",
            "updated_at": "string",
            "user_id": "string"
        }
    ]
}

3. Edit Team Member

PUT /edit-team-member/:workspaceId/:id/:memberId

Request Body Parameters

• email: The updated email address of the team member.
• area: The updated area name for the team member.

Response

Status	Description
200 OK	Team member details updated successfully.
406 Not Acceptable	Invalid ID provided for either company or operator.
500 Internal Server Error	Failed to update the team member details due to an unexpected error.

Response Object

{
    "message": "Team member edited successfully",
    "ok": true,
    "member": {
        "id": "string",
        "created_at": "string",
        "updated_at": "string",
        "email": "string",
        "area_id": "string",
        "company_name": "string",
        "platform_id": "string",
        "role_id": "string",
        "kyb_status": "string",
        "vat_number": "string",
        "sdi_or_pec": "string",
        "city_or_town": "string",
        "district_or_province": "string",
        "country_code": "string",
        "street_address": "string",
        "zip_or_postal_code": "string",
        "rea_code": "string"
    }
}

4. Delete Team Member

DELETE /delete-team-member/:workspaceId/:id/:memberId

Request Parameters

• workspaceId: The ID of the workspace.
• id: The ID of the company or operator.
• memberId: The ID of the team member to delete.

Response

Status	Description
200 OK	Team member deleted successfully from the workspace.
406 Not Acceptable	Invalid ID provided for either company or operator.
500 Internal Server Error	Failed to delete the team member due to an unexpected error.

Response Object

{
  "message": "Team member deleted successfully",
  "ok": true
}

5. View All Invitations

GET /view-invitations/:id

Request Parameters

• id: The ID of the company or operator whose invitations are being fetched.

Response

Status	Description
200 OK	Successfully fetched the list of pending invitations in the workspace.
406 Not Acceptable	Invalid ID provided for either company or operator.
500 Internal Server Error	Failed to fetch the invitations due to an unexpected error.

Response Object

{
  "invitations": [
    {
      "id": "string",
      "user_id": "string",
      "workspace_id": "string",
      "role_name": "member",
      "area_name": "string"
    }
  ]
}

6. Send Invitation

DELETE /send-invitaton

Request Object

Request Object:

• workspaceId: The ID of the workspace.
• id: The ID of the company or operator.
• invitationId: The ID of the invitation to delete.
• email: The email address of the user.
• password: The password for the user.
• area: The area associated with the user or request.
• status: The status of the user or invitation.
• encrypted_wallet: The encrypted wallet details.
• wallet_address: The address of the wallet.
• company_id: The ID of the company.
• operator_id: The ID of the operator.
• index: The index or position in a list.

Response

Status	Description
200 OK	Invitation sent successfully.
403 Not Acceptable	You have reached the maximum number of members.
500 Internal Server Error	Failed to sent the invitation due to an unexpected error.

Response Object

{
    "message": "string",
    "ok": true,
    "workspaceInvitation": {
        "id": "string",
        "workspace_id": "string",
        "area_id": "string",
        "area_name": "string",
        "company_id": "string",
        "created_at": "string",
        "email": "string",
        "encrypted_wallet": "string",
        "expiration_date": "string",
        "index": "integer",
        "operator_id": null,
        "password": "string",
        "status": "string",
        "updated_at": "string",
        "wallet_address": "string"
    }
}

7. Delete Invitation

DELETE /delete-invitation/:workspaceId/:id/:invitationId

Request Parameters

• workspaceId: The ID of the workspace.
• id: The ID of the company or operator.
• invitationId: The ID of the invitation to delete.

Response

Status	Description
200 OK	Invitation deleted successfully from the workspace.
406 Not Acceptable	Invalid ID provided for either company or operator.
500 Internal Server Error	Failed to delete the invitation due to an unexpected error.

Response Object

{
  "message": "Invitation deleted successfully",
  "ok": true
}