Local API V2 – Members and Permissions Interface

List Members

Endpoint

GET /openapi/v2/members

Returns the list of team Members.

Query Parameters

Name	Type	Required	Description
request	string	Yes	Member list query parameters.

Response Parameters

data.list contains the Members. See Member Fields for field details.

Create a Member

Endpoint

POST /openapi/v2/members

Creates a team Member.

Request Parameters

See Member Creation and Update Parameters for the request body fields.

Request Example

{
  "name": "automation member",
  "account": "automation@example.com",
  "authority": "staff",
  "status": "enabled",
  "all_profile_groups": false,
  "profile_group_ids": [],
  "type": "internal",
  "password": "password"
}

Get Member Details

Endpoint

GET /openapi/v2/members/{memberId}

Returns details about a Member.

Path Parameters

Name	Type	Required	Description
memberId	string	Yes	Member ID.

Update a Member

Endpoint

PATCH /openapi/v2/members/{memberId}

Updates Member information.

Path Parameters

Name	Type	Required	Description
memberId	string	Yes	Member ID.

Request Parameters

See Member Creation and Update Parameters for the request body fields. Omitted fields remain unchanged.

Delete a Member

Endpoint

DELETE /openapi/v2/members/{memberId}

Deletes a Member. Before deleting a Member, confirm that they no longer need access to the current team.

Path Parameters

Name	Type	Required	Description
memberId	string	Yes	Member ID.

Update a Member’s Accessible Profile Groups

Endpoint

PATCH /openapi/v2/members/{memberId}/profile-groups

Updates the Profile groups that a Member can access.

Path Parameters

Name	Type	Required	Description
memberId	string	Yes	Member ID.

Request Parameters

Name	Type	Required	Description
all_profile_groups	boolean	No	Whether the Member has access to all Profile groups.
profile_group_ids	string[]	No	IDs of the Profile groups the Member can access.

List Member Groups

Endpoint

GET /openapi/v2/member-groups

Returns the Member groups available to the current team.

Query Parameters

Name	Type	Required	Description
request	string	Yes	Role list query parameters.

Response Parameters

data.list contains the Member groups:

Name	Type	Description
id	string	Member group ID.
name	string	Member group name.
status	string	Role status: enabled or disabled.
remark	string	Remarks.

List Permissions for the Current Member

Endpoint

GET /openapi/v2/permissions

Returns the Permission list for the Member associated with the current API key.

Query Parameters

Name	Type	Required	Description
request	string	Yes	Permission list query parameters.

Response Parameters

data.list contains the Permissions:

Name	Type	Description
id	string	Permission ID.
code	string	Permission code.
name	string	Permission name.

Parameter Reference

Member Creation and Update Parameters

Name	Type	Required	Description
name	string	No	Member name.
account	string	No	Member account.
phone	string	No	Phone number.
authority	string	No	Member authority: admin, manager, or staff. A Member cannot be created or updated with the owner authority.
status	string	No	Member status: enabled or disabled.
role_id	string	No	Role ID. A super administrator role group cannot be assigned.
all_profile_groups	boolean	No	Whether the Member has access to all Profile groups.
profile_group_ids	string[]	No	IDs of the Profile groups the Member can access. Applies when all_profile_groups=false.
manager_id	string	No	ID of the Member’s manager.
type	string	No	Member type: external or internal.
password	string	No	Member password.
remark	string	No	Remarks.
expiry	object	No	Expiration-based deactivation settings. See Member Expiration Settings.

Member Expiration Settings

Name	Type	Required	Description
enabled	boolean	No	Whether to enable expiration-based deactivation.
timezone	string	No	Member time zone, for example, Asia/Shanghai.
time	string	No	Expiration time in yyyy-MM-dd HH:mm:ss format.
mode	string	No	Expiration mode: instant or login_start.
days	integer	No	Number of days after login before expiration. Applies when mode=login_start.

Member Fields

Name	Type	Description
id	string	Member ID.
name	string	Member name.
account	string	Member account.
authority	string	Member authority: owner, admin, manager, or staff.
status	string	Member status: enabled or disabled.
role_id	string	Role ID.
role_name	string	Role name.
all_profile_groups	boolean	Whether the Member has access to all Profile groups.
profile_group_ids	string[]	IDs of the Profile groups the Member can access.
profile_groups	object[]	Summary information about the Profile groups the Member can access.
type	string	Member type: external or internal.
remark	string	Remarks.
created_at	string	Creation time.
updated_at	string	Last update time.