Get a group

Tool Name: airdroid_business_get_group

Risk Level: 🟢 Low Risk

Execution Mode: ⚡ Synchronous

Category: Group Management

Quick Start (Copy & Use)

One-liner: Retrieve detailed group information by GroupId, including name, remark, sub-groups list, and more.

You need: GroupId (group unique identifier)

Success criteria: StatusCode == 200 AND ErrorMessage == "" AND Group object is not empty

What to do next: Use the group info for device assignment, group management, or displaying the group hierarchy

Minimum request example:

{
  "GroupId": 123
}

Minimum response example:

{
  "Group": {
    "id": "123",
    "name": "Sales Team",
    "owner_id": "10001",
    "create_date": "2024-06-15 10:30:00",
    "update_date": "2024-12-01 14:20:00",
    "is_default": "0",
    "deploy_code": "ABC123XYZ",
    "pid": "0",
    "remark": "Sales department devices",
    "device_count": 25,
    "sub_groups": []
  },
  "StatusCode": 200,
  "ErrorMessage": ""
}

Recipes (Common Recipes)

Recipe 1: Get top-level group information

Scenario: Query basic information and device count of a top-level group

{
  "GroupId": 123
}

Recipe 2: Get group information including sub-groups

Scenario: Query parent group info along with all its sub-groups

{
  "GroupId": 100
}

Expected response (with sub-groups):

{
  "Group": {
    "id": "100",
    "name": "Sales Department",
    "pid": "0",
    "device_count": 50,
    "sub_groups": [
      {
        "id": "101",
        "name": "North Sales",
        "pid": "100",
        "remark": "Northern region"
      },
      {
        "id": "102",
        "name": "South Sales",
        "pid": "100",
        "remark": "Southern region"
      }
    ]
  },
  "StatusCode": 200,
  "ErrorMessage": ""
}

Recipe 3: Look up GroupId first, then get group details

Scenario: Only know the group name; need to get GroupId first and then query group details

Step 1: Call Get a Group ID by Group Name

{
  "GroupName": "Sales Team"
}

Step 2: Use the returned GroupId to call this tool

{
  "GroupId": 123
}

1. Overview

1.1 Description

Retrieve detailed information of a device group in AirDroid Business by its unique identifier (GroupId), including the group name, remark, creation time, device count, and sub-groups list.

1.2 When to Use

• View group details: Need the full information of a group, including device count and remark
• Get group hierarchy: Need to retrieve a parent group and all its sub-groups
• Verify group existence: Confirm whether a GroupId corresponds to an existing group
• Get deploy code: Retrieve the group's deploy_code for device enrollment

1.3 Execution Mode & Response

This is a synchronous operation that returns group information immediately.

• Return value: Group object (full group information)
• Typical latency: < 1 second

1.4 Prerequisites

1.5 Prerequisite Tools

1.6 Comparison with Similar Tools

2. Inputs

2.1 Parameter List

2.2 Parameter Details

`GroupId`

Unique identifier of the group, used to precisely locate the group to query.

• Type: number (integer)
• Format requirements: Must be a positive integer greater than 0
• Source:

How to obtain:

1. Use Get a Group ID by Group Name to look up by group name
2. Use the group_id field from Get All Devices response
3. Use the GroupId returned by Create a Group

• How to fill in a GI node:
  • Constant value: Enter a number directly, e.g. 123
  • Upstream output reference: Get from Get a Group ID by Group Name output GroupIds[0]
• Example:

123

3. Outputs

3.1 Response Examples

Success response:

{
  "Group": {
    "id": "123",
    "name": "Sales Team",
    "owner_id": "10001",
    "create_date": "2024-06-15 10:30:00",
    "update_date": "2024-12-01 14:20:00",
    "is_default": "0",
    "deploy_code": "ABC123XYZ",
    "pid": "0",
    "remark": "Sales department devices",
    "device_count": 25,
    "sub_groups": [
      {
        "id": "124",
        "name": "North Sales",
        "owner_id": "10001",
        "deploy_code": "DEF456ABC",
        "is_default": "0",
        "pid": "123",
        "remark": "Northern region sales team"
      },
      {
        "id": "125",
        "name": "South Sales",
        "owner_id": "10001",
        "deploy_code": "GHI789DEF",
        "is_default": "0",
        "pid": "123",
        "remark": "Southern region sales team"
      }
    ]
  },
  "StatusCode": 200,
  "ErrorMessage": ""
}

Error response (group not found):

{
  "Group": {},
  "StatusCode": 200,
  "ErrorMessage": "Group not found"
}

Error response (parameter error):

{
  "Group": {},
  "StatusCode": -1,
  "ErrorMessage": "Invalid group_id."
}

3.2 Field Descriptions

3.3 Status Code / Enum Value Mappings

4. Examples

4.1 Basic Example: Get single group information

Request parameters:

{
  "GroupId": 123
}

Response:

{
  "Group": {
    "id": "123",
    "name": "Sales Team",
    "owner_id": "10001",
    "create_date": "2024-06-15 10:30:00",
    "update_date": "2024-12-01 14:20:00",
    "is_default": "0",
    "deploy_code": "ABC123XYZ",
    "pid": "0",
    "remark": "Sales department devices",
    "device_count": 25,
    "sub_groups": []
  },
  "StatusCode": 200,
  "ErrorMessage": ""
}

4.2 Advanced Example: Get group hierarchy with sub-groups

Request parameters:

{
  "GroupId": 100
}

Response:

{
  "Group": {
    "id": "100",
    "name": "Regional Teams",
    "owner_id": "10001",
    "create_date": "2024-01-10 09:00:00",
    "update_date": "2024-12-15 16:45:00",
    "is_default": "0",
    "deploy_code": "REG100ABC",
    "pid": "0",
    "remark": "All regional sales teams",
    "device_count": 150,
    "sub_groups": [
      {
        "id": "101",
        "name": "North Region",
        "owner_id": "10001",
        "deploy_code": "NOR101DEF",
        "is_default": "0",
        "pid": "100",
        "remark": "Northern region devices"
      },
      {
        "id": "102",
        "name": "South Region",
        "owner_id": "10001",
        "deploy_code": "SOU102GHI",
        "is_default": "0",
        "pid": "100",
        "remark": "Southern region devices"
      }
    ]
  },
  "StatusCode": 200,
  "ErrorMessage": ""
}

4.3 Error Example: Group not found

Request parameters:

{
  "GroupId": 99999
}

Response:

{
  "Group": {},
  "StatusCode": 200,
  "ErrorMessage": "Group not found"
}

5. Error Handling

5.1 AB Three-Layer Error Codes

Core principle: AB uses a three-layer error code strategy. The Agent should decide its handling approach based on the StatusCode.

5.2 Common Errors

5.3 Agent Self-Healing Decision Table

6. Best Practices

6.1 Performance Optimization

• Cache group info: Group information changes infrequently; cache results to reduce redundant queries
• Batch query scenario: When querying multiple groups, consider iterating or using other tools to get device lists

6.2 Security Considerations

🟢 Read operation: No special security concerns; this operation does not modify any data.

7. Related Tools

7.1 Prerequisite Tools

7.2 Follow-up Tools

7.3 Similar Tools Comparison

8. Tool Chains

8.1 Look Up Group Details by Name

Scenario: User provides a group name; need to retrieve full group information

Tool chain:

Get a Group ID by Group Name → Get a Group

Steps:

1. Call Get a Group ID by Group Name with the group name
2. Take the first value from the returned GroupIds array
3. Use that GroupId to call Get a Group for full information

8.2 Get Details After Creating a Group

Scenario: After creating a new group, retrieve full group info (including deploy code)

Tool chain:

Create a Group → Get a Group

Steps:

1. Call Create a Group to create the new group
2. Use the returned GroupId to call Get a Group
3. Retrieve full info including deploy_code for device enrollment

8.3 View Group Hierarchy Structure

Scenario: Need to understand a group and all its sub-groups

Tool chain:

Get a Group (parent group) → [Optional] Get a Group (each sub-group)

Steps:

1. Call Get a Group to retrieve the parent group info
2. Get all sub-group basic info from the sub_groups array
3. If detailed sub-group info is needed, iterate and call Get a Group for each