List Groups

Tool Name: airdroid_business_group_list

Risk Level: 🟢 Low Risk

Execution Mode: ⚡ Synchronous

Category: Group Management

Quick Start (Copy & Use)

Summary: Retrieve a paginated list of device groups in the account (no filter). Returns normalized group fields including hierarchy path and paging metadata.

Prerequisites: A valid OAuth2 AccessToken configured in the GI node Credential.

Success Criteria: StatusCode == 200 and ErrorMessage == "".

What to Do Next: Use Groups[].id as GroupId, or pass names into Batch Resolve Group IDs by Name / Resolve Group ID by Name when you already know names.

Minimal Request Example (recommended to copy directly):

{
  "PageIndex": 1,
  "PageSize": 50
}

Minimal Response Example:

{
  "Groups": [
    {
      "id": 123,
      "name": "Sales",
      "parent_group_id": 0,
      "remark": "",
      "deploy_code": "ABC123",
      "create_date": "2024-01-15 10:30:00",
      "is_default": "No",
      "is_leaf": "Yes",
      "level": 1,
      "max_child_depth": 0,
      "path": ["Sales"]
    }
  ],
  "Pagination": {
    "total": 1,
    "page_size": 50,
    "page_index": 1,
    "last_page": 1
  },
  "StatusCode": 200,
  "ErrorMessage": ""
}

Recipes (Common Recipes)

Recipe 1: First page with default page size

When to use: Browse groups starting from the first page.

{
  "PageIndex": 1,
  "PageSize": 50
}

Recipe 2: Smaller pages for hierarchy review

When to use: Walk the account group list with smaller pages.

{
  "PageIndex": 1,
  "PageSize": 20
}

Recipe 3: Paginate until the last page

When to use: Collect all groups by advancing PageIndex while page_index < last_page.

{
  "PageIndex": 2,
  "PageSize": 50
}

Paging rule: After each success response, if Pagination.page_index < Pagination.last_page, call again with PageIndex = Pagination.page_index + 1 (same PageSize).

1. Overview

1.1 What it does

Lists device groups for the current credential with pagination. Unlike Search Groups, this tool has no Filter — it returns the account group list page by page.

1.2 When to use

• Listing groups for selection or management UIs
• Building a hierarchy overview before creating sub-groups
• Paginating through all groups in the account

1.3 Execution mode

This is a synchronous read. The call returns Groups and Pagination immediately.

1.4 Prerequisites

1.5 Related tools

1.6 vs similar tools

2. Inputs

2.1 Parameter table

The GI node sends PageSize = 50 by default. Set it explicitly when response size matters; accepted values are 1–100.

2.2 Details

`PageIndex`

• Must be an integer >= 1
• Invalid values → StatusCode = -1 with Hint to set a positive integer starting from 1

`PageSize`

• Must be an integer between 1 and 100
• Invalid values → StatusCode = -1

3. Outputs

3.1 Output table

3.2 `Groups[]` common fields

Items commonly include:

Exact enum string sets for flags are defined by the upstream group API response shape; do not invent values beyond what you observe in responses.

3.3 Pagination

When Pagination.page_index < Pagination.last_page, request the next page with PageIndex = page_index + 1.

4. Error handling

Examples from runtime:

• Invalid PageIndex → -1, Hint: set integer starting from 1
• Invalid PageSize → -1, Hint: set 1–100
• HTTP 429 → 500, Retryable true
• Timeout (60s) → 500, Retryable true

Business failures (code != 1 from upstream) keep StatusCode = 200 with non-empty ErrorMessage (check ErrorMessage, not only StatusCode).

5. Limits & gotchas

• No filter support — use Search Groups for conditions
• PageSize max 100
• Results are scoped to the current credential’s visible groups

6. Best practices

1. Set PageSize explicitly to avoid default-text conflicts (50 vs 20)
2. Prefer Search Groups when you already know name / parent / date criteria
3. Use path to disambiguate same-named groups under different parents

7. Related Tools

7.1 Follow-up

7.2 Comparison

8. Tool Chains

8.1 List then resolve / act

List Groups → (pick names or ids) → Move Devices to a Group / Update a Group Name / …

8.2 Prefer Search when filtering

Search Groups (Filter) → use Groups[].id

Appendix Reference:

• Field Reference: ./Field Reference.md
• Error Code Quick Reference: ./Error Codes.md