👥 User Groups

User group management and membership endpoints. 8 endpoints available.

🎯 Quick Stats

Total Endpoints: 8
Base URL: https://api.market.decenctype.com
Authentication: Bearer Token / API Key

📊 Methods

📝 POST: 3 endpoints
🔍 GET: 3 endpoints
🗑️ DELETE: 1 endpoints
✏️ PUT: 1 endpoints

🔐 Authentication

All endpoints in this section use the same authentication methods. Choose one:

🔑 Bearer Token (Recommended)

For user session authentication

Add to request headers:

Authorization: Bearer YOUR_TOKEN

🔧 API Key

For server-side authentication

Add to request headers:

X-API-KEY: YOUR_API_KEY

⚠️ Important: Do not use both authentication methods simultaneously in the same request.

🔗 Endpoints Overview

Method	Endpoint	Description
📝 `POST`	`/user-groups`	Create user group
🔍 `GET`	`/user-groups`	Get all user groups
📝 `POST`	`/user-groups/members`	Add user to group
🔍 `GET`	`/user-groups/{groupId}/members`	Get group members
🔍 `GET`	`/user-groups/users/{userId}/groups`	Get user groups for a user
🗑️ `DELETE`	`/user-groups/members/{userId}/{groupId}`	Remove user from group
✏️ `PUT`	`/user-groups/memberships/{membershipId}/status`	Update membership status
📝 `POST`	`/user-groups/merchant/{merchantId}/ensure-default-group`	Ensure merchant has default user group

📖 Detailed Documentation

Create user group

POST/user-groups

Full URL

https://api.market.decenctype.com/user-groups

📝 Request Body Parameters

Parameter	Type	Required	Description
`groupName`	`string`	✅	用户组名称 (最小长度: 2, 最大长度: 100)
`description`	`string`	❌	用户组描述
`type`	`string (standard, vip, enterprise, custom)`	❌	用户组类型 (默认: standard)
`priority`	`number`	❌	用户组优先级 (默认: 100) (最小: 1, 最大: 999)
`maxMembers`	`number`	❌	最大成员数量 (最小: 1)
`config`	`object`	❌	用户组配置
`merchantId`	`string`	❌	商户ID

Description: Create user group

Operation ID: createUserGroup

Response Status:

✅ 201: User group created successfully

📋 Response Examples

response.json

1{
2  "groupId": "123e4567-e89b-12d3-a456-426614174000",
3  "groupName": "VIP用户组",
4  "description": "VIP用户享受更低的手续费率",
5  "type": "vip",
6  "status": "active",
7  "priority": 100,
8  "maxMembers": 1000,
9  "config": {
10    "features": [
11      "advanced_trading",
12      "priority_support"
13    ],
14    "limits": {
15      "dailyTransactionLimit": 100000
16    }
17  },
18  "merchantId": "123e4567-e89b-12d3-a456-426614174000",
19  "isDefault": false,
20  "createdAt": "2023-12-01T10:30:00Z",
21  "updatedAt": "2023-12-01T10:30:00Z",
22  "fee": "example-fee",
23  "merchant": "example-merchant",
24  "memberships": [
25    {
26      "membershipId": "123e4567-e89b-12d3-a456-426614174000",
27      "userId": "123e4567-e89b-12d3-a456-426614174000",
28      "groupId": "123e4567-e89b-12d3-a456-426614174000",
29      "role": "member",
30      "status": "active",
31      "user": "example-user",
32      "userGroup": "example-userGroup"
33    }
34  ]
35}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/user-groups" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "groupName": "VIP用户组"
}'

Get all user groups

GET/user-groups

Full URL

https://api.market.decenctype.com/user-groups

📋 Query Parameters

Parameter	Type	Required	Description
`status`	`string`	❌	No description
`type`	`string`	❌	No description
`merchantId`	`string`	❌	Filter by merchant ID
`page`	`number`	❌	No description
`pageSize`	`number`	❌	No description

Description: Get all user groups

Operation ID: getAllUserGroups

Response Status:

✅ 200: User groups retrieved successfully

📋 Response Examples

response.json

1[
2  {
3    "groupId": "123e4567-e89b-12d3-a456-426614174000",
4    "groupName": "VIP用户组",
5    "description": "VIP用户享受更低的手续费率",
6    "type": "vip",
7    "status": "active",
8    "priority": 100,
9    "maxMembers": 1000,
10    "config": {
11      "features": [
12        "advanced_trading",
13        "priority_support"
14      ],
15      "limits": {
16        "dailyTransactionLimit": 100000
17      }
18    },
19    "merchantId": "123e4567-e89b-12d3-a456-426614174000",
20    "isDefault": false,
21    "createdAt": "2023-12-01T10:30:00Z",
22    "updatedAt": "2023-12-01T10:30:00Z",
23    "fee": "example-fee",
24    "merchant": "example-merchant",
25    "memberships": [
26      {
27        "membershipId": "123e4567-e89b-12d3-a456-426614174000",
28        "userId": "123e4567-e89b-12d3-a456-426614174000",
29        "groupId": "123e4567-e89b-12d3-a456-426614174000",
30        "role": "member",
31        "status": "active",
32        "user": "example-user",
33        "userGroup": "example-userGroup"
34      }
35    ]
36  }
37]

📝 Example Request

curl -X GET "https://api.market.decenctype.com/user-groups" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Add user to group

POST/user-groups/members

Full URL

https://api.market.decenctype.com/user-groups/members

📝 Request Body Parameters

Parameter	Type	Required	Description
`userId`	`string`	✅	用户ID
`groupId`	`string`	✅	用户组ID
`role`	`string (member, admin, owner)`	❌	成员角色 (默认: member)
`invitedBy`	`string`	❌	邀请人ID
`notes`	`string`	❌	成员备注
`expiresAt`	`string (date-time)`	❌	过期时间

Description: Add user to group

Operation ID: addUserToGroup

Response Status:

✅ 201: User added to group successfully

📋 Response Examples

response.json

1{
2  "membershipId": "123e4567-e89b-12d3-a456-426614174000",
3  "userId": "123e4567-e89b-12d3-a456-426614174000",
4  "groupId": "123e4567-e89b-12d3-a456-426614174000",
5  "role": "member",
6  "status": "active",
7  "joinedAt": "2023-12-01T10:30:00Z",
8  "expiresAt": "2024-12-01T10:30:00Z",
9  "invitedBy": "123e4567-e89b-12d3-a456-426614174000",
10  "notes": "高价值客户",
11  "config": {
12    "permissions": [
13      "view_reports",
14      "manage_settings"
15    ],
16    "preferences": {
17      "notifications": true
18    }
19  },
20  "user": "example-user",
21  "userGroup": "example-userGroup"
22}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/user-groups/members" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "groupId": "123e4567-e89b-12d3-a456-426614174000"
}'

Get group members

GET/user-groups/{groupId}/members

Full URL

https://api.market.decenctype.com/user-groups/{groupId}/members

🎯 Path Parameters

groupId (string) - ✅ Required: User group ID

📋 Query Parameters

Parameter	Type	Required	Description
`status`	`string`	❌	No description
`role`	`string`	❌	No description
`page`	`number`	❌	No description
`pageSize`	`number`	❌	No description

Description: Get group members

Operation ID: getGroupMembers

Response Status:

✅ 200: Group members retrieved successfully

📋 Response Examples

response.json

1[
2  {
3    "membershipId": "123e4567-e89b-12d3-a456-426614174000",
4    "userId": "123e4567-e89b-12d3-a456-426614174000",
5    "groupId": "123e4567-e89b-12d3-a456-426614174000",
6    "role": "member",
7    "status": "active",
8    "joinedAt": "2023-12-01T10:30:00Z",
9    "expiresAt": "2024-12-01T10:30:00Z",
10    "invitedBy": "123e4567-e89b-12d3-a456-426614174000",
11    "notes": "高价值客户",
12    "config": {
13      "permissions": [
14        "view_reports",
15        "manage_settings"
16      ],
17      "preferences": {
18        "notifications": true
19      }
20    },
21    "user": "example-user",
22    "userGroup": "example-userGroup"
23  }
24]

📝 Example Request

curl -X GET "https://api.market.decenctype.com/user-groups/example-id/members" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Get user groups for a user

GET/user-groups/users/{userId}/groups

Full URL

https://api.market.decenctype.com/user-groups/users/{userId}/groups

🎯 Path Parameters

userId (string) - ✅ Required: User ID

Description: Get user groups for a user

Operation ID: getUserGroups

Response Status:

✅ 200: User groups retrieved successfully

📋 Response Examples

response.json

1[
2  {
3    "membershipId": "123e4567-e89b-12d3-a456-426614174000",
4    "userId": "123e4567-e89b-12d3-a456-426614174000",
5    "groupId": "123e4567-e89b-12d3-a456-426614174000",
6    "role": "member",
7    "status": "active",
8    "joinedAt": "2023-12-01T10:30:00Z",
9    "expiresAt": "2024-12-01T10:30:00Z",
10    "invitedBy": "123e4567-e89b-12d3-a456-426614174000",
11    "notes": "高价值客户",
12    "config": {
13      "permissions": [
14        "view_reports",
15        "manage_settings"
16      ],
17      "preferences": {
18        "notifications": true
19      }
20    },
21    "user": "example-user",
22    "userGroup": "example-userGroup"
23  }
24]

📝 Example Request

curl -X GET "https://api.market.decenctype.com/user-groups/users/example-id/groups" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Remove user from group

DELETE/user-groups/members/{userId}/{groupId}

Full URL

https://api.market.decenctype.com/user-groups/members/{userId}/{groupId}

🎯 Path Parameters

userId (string) - ✅ Required: No description
groupId (string) - ✅ Required: No description

Description: Remove user from group

Operation ID: removeUserFromGroup

Response Status:

✅ 200: User removed from group successfully

📝 Example Request

curl -X DELETE "https://api.market.decenctype.com/user-groups/members/example-id/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Update membership status

PUT/user-groups/memberships/{membershipId}/status

Full URL

https://api.market.decenctype.com/user-groups/memberships/{membershipId}/status

🎯 Path Parameters

membershipId (string) - ✅ Required: No description

📝 Request Body Parameters

Parameter	Type	Required	Description
`status`	`string (active, inactive, pending, suspended)`	✅	成员状态
`notes`	`string`	❌	备注

Description: Update membership status

Operation ID: updateMembershipStatus

Response Status:

✅ 200: Membership status updated successfully

📋 Response Examples

response.json

1{
2  "membershipId": "123e4567-e89b-12d3-a456-426614174000",
3  "userId": "123e4567-e89b-12d3-a456-426614174000",
4  "groupId": "123e4567-e89b-12d3-a456-426614174000",
5  "role": "member",
6  "status": "active",
7  "joinedAt": "2023-12-01T10:30:00Z",
8  "expiresAt": "2024-12-01T10:30:00Z",
9  "invitedBy": "123e4567-e89b-12d3-a456-426614174000",
10  "notes": "高价值客户",
11  "config": {
12    "permissions": [
13      "view_reports",
14      "manage_settings"
15    ],
16    "preferences": {
17      "notifications": true
18    }
19  },
20  "user": "example-user",
21  "userGroup": "example-userGroup"
22}

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/user-groups/memberships/example-id/status" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "status": "active"
}'

Ensure merchant has default user group

POST/user-groups/merchant/{merchantId}/ensure-default-group

Full URL

https://api.market.decenctype.com/user-groups/merchant/{merchantId}/ensure-default-group

🎯 Path Parameters

merchantId (string) - ✅ Required: Merchant ID

Description: Ensure merchant has default user group

Operation ID: ensureMerchantHasDefaultUserGroup

Response Status:

✅ 200: Merchant default user group ensured successfully
✅ 201: Success

📋 Response Examples

response.json

1{
2  "hasDefaultGroup": true,
3  "defaultGroup": {},
4  "usersAdded": 1
5}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/user-groups/merchant/example-id/ensure-default-group" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

👥 User Groups

🎯 Quick Stats

📊 Methods

🔑 Bearer Token (Recommended)

🔧 API Key

On this page