List Organization App Library Applications

Tool Name: Not defined in the current tool contract

Risk Level: Read

Execution Mode: Synchronous

Category: Organization App Library

Quick Start (Copy and Use)

Summary: Browse Organization App Library applications with simple platform, keyword, sorting, and pagination controls.

Prerequisites: A configured AirDroid Business credential. No application or release ID is required.

Success Criteria: StatusCode is 200 and ErrorMessage is empty. Applications and Pagination then contain the current page; an empty Applications array is a valid result.

What to Do Next: Use latest_release.release_id from an application that has latest_release to inspect that release with List Organization App Library Distribution Status.

Minimal Request Example:

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

Minimal Response Example:

{
  "Applications": [],
  "Pagination": {
    "total": 0,
    "page_size": 20,
    "page_index": 1,
    "last_page": 1
  },
  "Hint": "",
  "Retryable": false,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": ""
}

Recipes (Common Recipes)

Recipe 1: Browse One Platform

When to use: You need a simple catalog view of applications for one platform.

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

Recipe 2: Find by Name or Package ID Text

When to use: A substring is sufficient and a structured filter is not needed.

{
  "Platform": "All",
  "Keyword": "agent",
  "SortBy": "updated_at",
  "SortOrder": "desc",
  "PageIndex": 1,
  "PageSize": 20
}

Recipe 3: Read the Next Page

When to use: A successful response has Pagination.page_index < Pagination.last_page.

{
  "Platform": "All",
  "Keyword": "",
  "SortBy": "name",
  "SortOrder": "asc",
  "PageIndex": 2,
  "PageSize": 100
}

1. Overview

1.1 Description

Lists the Organization App Library using only the simple Platform and Keyword controls, plus sorting and pagination.

1.2 When to Use

• Browse a platform-specific or complete application catalog.
• Find an application by a name or package ID substring.
• Obtain an application's latest_release.release_id for release-specific work.

1.3 Execution Mode and Response

This is a synchronous, read-only operation. It is idempotent. A successful page can contain zero applications; that is not an error.

1.4 Prerequisites

1.5 Prerequisite Tools

No other tool is required.

1.6 Similar Tools

Use Search Organization App Library Applications when the simple Platform and Keyword controls are insufficient and structured Filter conditions are needed. Use List Organization App Library Distribution Status only after obtaining a specific latest_release.release_id and needing per-device rollout information.

2. Inputs

2.1 Parameter List

2.2 Parameter Details

`Platform`

Allowed values are All, Android, Windows, and Web. Values are accepted case-insensitively and returned in the canonical capitalization. Use All to include every platform.

`Keyword`

Provide a string of at most 255 characters. It matches any part of the application name or package ID without regard to case. Leave it empty to include all applications. It is a simple text control, not a structured filter.

`SortBy` and `SortOrder`

SortBy is name or updated_at. SortOrder is asc or desc. name sorts by application name; updated_at sorts by last application update time.

`PageIndex` and `PageSize`

The DSL types are number. At runtime, each value may also be a digit-only string, with surrounding whitespace trimmed, and is converted to an integer. Use a positive whole number such as 1 or a compatible numeric string such as "1"; decimals, exponent notation, non-numeric text, zero, and negative values are invalid. PageIndex defaults to 1 and PageSize defaults to 20 when omitted or blank. PageSize is limited to 1 through 100; keep it small when only a few results are needed.

2.3 Parameter Combination Logic

Platform, Keyword, sorting, and pagination apply to the same browse request. For the next page, retain the same controls and increase PageIndex only while Pagination.page_index < Pagination.last_page.

3. Outputs

3.1 Response Examples

The Quick Start response is a successful empty page.

Invalid page size:

{
  "Applications": [],
  "Pagination": {},
  "Hint": "Use PageSize between 1 and 100, then retry.",
  "Retryable": false,
  "OriginalStatusCode": 0,
  "StatusCode": -1,
  "ErrorMessage": "PageSize 101 exceeds the maximum (100)."
}

3.2 Field Descriptions

3.3 Status and Enum Values

3.4 Pagination

Pagination.page_index and Pagination.last_page are 1-based. When page_index < last_page, request the next page with PageIndex + 1. PageSize defaults to 20 and cannot exceed 100.

4. Examples

4.1 Basic Example: Browse All Applications

{
  "Platform": "All",
  "Keyword": "",
  "SortBy": "updated_at",
  "SortOrder": "desc",
  "PageIndex": 1,
  "PageSize": 20
}

4.2 Advanced Example: Alphabetical Platform Browse

{
  "Platform": "Windows",
  "Keyword": "",
  "SortBy": "name",
  "SortOrder": "asc",
  "PageIndex": 1,
  "PageSize": 100
}

4.3 Error Example: Unsupported Platform

{
  "Platform": "Linux"
}

This returns StatusCode -1, ErrorMessage Platform is invalid., and a hint to use All, Android, Windows, or Web.

5. Error Handling

6. Best Practices

6.1 Performance

Use Keyword and Platform before paging through a large catalog. Request only the page size needed for the current decision.

6.2 Safety

This is read-only and does not change the Organization App Library.

6.3 Idempotency

Idempotent. Repeating the same read request does not change application-library state.

7. Related Tools

8. Tool Chains

8.1 Browse a Release and Inspect Its Rollout

List Organization App Library Applications -> List Organization App Library Distribution Status

1. Browse applications and select an item whose latest_release is not null.
2. Pass latest_release.release_id as ReleaseId to List Organization App Library Distribution Status.
3. Use Counts and Records to inspect the rollout; do not treat the list page itself as rollout status.