Teams & members

Team APIs

Get team information

Endpoint: /org-info

Method: GET

Request parameters:

Request example:

curl --location --request GET 'https://open.musedam.ai/api/muse/org-info' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json'

Response:

{
    "code": "0",
    "message": "OK",
    "result": {
        "id": 185,
        "name": "Example team",
        "orgNo": "M000001",
        "orgFeeType": 4
    },
    "traceId": "17555160673301652392"
}

Get team credit balance

Endpoint: /org-point-info

Method: GET

Description: Get the remaining credit balance of the team associated with the API Key.

Request parameters: None. The API Key identifies the team; no team ID is required.

Response fields:

Example request:

curl --location --request GET 'https://open.musedam.ai/api/muse/org-point-info' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json'

Example response (illustrative balance):

{
  "code": "0",
  "message": "OK",
  "result": 1250.5,
  "traceId": "example-trace-id"
}

Read result directly to obtain the remaining credits.

Get team member information

Endpoint: /org-member-info

Method: POST

Request parameters:

{
    "userId": "1765276754630496256"
}

Request example:

curl --location --request POST 'https://open.musedam.ai/api/muse/org-member-info' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userId": "1765276754630496256"
}'

Response:

{
    "code": "0",
    "message": "OK",
    "result": {
        "userId": "1765276754630496256",
        "realName": "xxx",
        "nickName": "xxxx",
        "avatarUrl": "https://example.com/avatar.png",
        "roleCode": "admin",
        "departmentIds": [
            0,
            200
        ],
        "groupIds": [
            20,
            22
        ]
    },
    "traceId": "17561978534182325498"
}

Query team members

Endpoint: /org-members-query

Method: POST

Description: Query members of the current team with pagination and optional keyword, department, and status filters.

Request parameters:

Response structure:

records[] fields:

orgRoleVO fields:

departmentList[] fields:

Example request:

curl --location --request POST 'https://open.musedam.ai/api/muse/org-members-query' \
--header 'Authorization: Bearer your_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{"page":1,"pageSize":10,"keyword":""}'

Query team allowlist members

Endpoint: /org-whitelist-query

Method: POST

Description: Query the current team's allowlist members with pagination and optional keyword and group filters.

Request parameters:

Response structure:

records[] fields:

groups[] fields:

Example request:

curl --location --request POST 'https://open.musedam.ai/api/muse/org-whitelist-query' \
--header 'Authorization: Bearer your_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{"page":1,"pageSize":10,"keyword":""}'

Query team departments

Endpoint: /org-departments-query

Method: GET

Description: Get the direct child departments of a parent department in the current team. parentId=0 returns root departments.

Request parameters:

Response: A list of objects containing id and name.

Request example:

curl --location --request GET 'https://open.musedam.ai/api/muse/org-departments-query?parentId=0' \
--header 'Authorization: Bearer your_api_key'

Query team groups

Endpoint: /org-groups-query

Method: GET

Description: Get the direct child groups of a parent member group in the current team. parentId=0 returns root groups. Only enterprise team member groups are returned; enterprise allowlist groups are excluded.

Request parameters:

Response: A list of objects containing id and name.

Request example:

curl --location --request GET 'https://open.musedam.ai/api/muse/org-groups-query?parentId=0' \
--header 'Authorization: Bearer your_api_key'

Query members by department ID

Endpoint: /department-members-query

Method: GET

Description: Query department members, optionally including subdepartments. Fields generally match records[] in /org-members-query.

Request parameters:

Request example:

curl --location --request GET 'https://open.musedam.ai/api/muse/department-members-query?departmentId=123&needChildMember=false' \
--header 'Authorization: Bearer your_api_key'

Query members by group ID

Endpoint: /group-members-query

Method: POST

Description: Query enterprise team group members with pagination. Fields generally match records[] in /org-members-query, except enterprise role information is not returned.

Request parameters:

Response: Contains records / total / current / size.

Request example:

curl --location --request POST 'https://open.musedam.ai/api/muse/group-members-query' \
--header 'Authorization: Bearer your_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{"groupId":1,"keyWord":"","needChildMember":false,"page":1,"pageSize":10}'

Send an in-app notification

Endpoint: /add-in-app-notify

Method: POST

Description: Send an in-app notification to a user in an enterprise workspace. The notification is stored and processed through the same follow-up flow as the console, including Feishu delivery where configured. Notifications can reference folders, assets, or asset groups and cover collaboration, deletion, permission requests and decisions, comments, and team changes. Use notificationType together with resource fields to describe the event. This endpoint lets third-party systems send notifications in automated workflows.

Request body: req

notificationType

resourceType

Use with resourceId, which identifies the business record of the selected type, such as a folder, asset, or team ID.

Response: result is a Boolean.

Example request:

curl --location --request POST 'https://open.musedam.ai/api/muse/add-in-app-notify' \
--header 'Authorization: Bearer your_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "notificationType": "permission_approved",
    "receiverId": 1765276754630496256,
    "resourceType": 1,
    "resourceId": 1234567890,
    "resourceName": "Brand asset library",
    "content": "Request permission to view this shared folder",
    "permissionApprovedRoleId": 2
}'

Example response:

{
    "code": "0",
    "message": "OK",
    "result": true,
    "traceId": "17561978534182325498"
}