List all mobile apps

Request

This request uses the GET method, which is used to retrieve a paginated list of mobile apps with their metadata and details from the specified resource.

For basic authorization, replace this with your username and password (or API key) in the username:password or username:api_key format. Your user credentials are combined to form a Base64-encoded string.

The request data is provided as a JSON object. You can optionally include the following query parameters:

pageToken: Token for retrieving the next page of results. Use the token provided in the previous response.
limit: Number of records to return per page. Defaults to 10 if not specified.

Response

The response includes details about the total count, pagination token, and a list of mobile apps, each containing its associated metadata and attributes.

See the following example:

{
  "count": 0,
  "pageToken": "string",
  "items": {
    "id": "b3f3c0a0-0f5a-4f4a-8f4a-0b9e4b0f4a0f",
    "organizationId": "1234",
    "name": "Katalon Demo App",
    "platform": "ANDROID",
    "universalAppId": "com.katalon.app.ios, com.katalon.app.android",
    "status": "NEW",
    "size": 123456,
    "description": "This is a demo app",
    "storagePath": "string",
    "reason": "App size is too big",
    "uploadedDate": "2022-03-10T16:15:50.000Z",
    "metadata": {
      "appId": "com.katalon.app",
      "identifier": "com.katalon.app",
      "name": "Katalon Demo App",
      "version": "1.0.0",
      "versionCode": "1",
      "minSdk": 11,
      "targetSdk": 15
    },
    "createdDate": "2022-03-10T12:15:50.000Z",
    "updatedDate": "2022-03-10T12:15:50.000Z",
    "fileName": "KatalonDemoApp.apk"
  }
}

Refer to the following table about the response body properties:

Property	Type	Description
`count`	Integer	Total number of apps retrieved in the response.
`pageToken`	String	Token to retrieve the next page of results.
`items`	Object	An array of mobile app records, each representing a specific mobile app with detailed attributes
`items.id`	String	Unique identifier for the mobile app.
`items.organizationId`	String	ID of the organization the app belongs to.
`items.name`	String	Name of the mobile app.
`items.platform`	String	Platform of the mobile app (e.g., `ANDROID`, `iOS`).
`items.universalAppId`	String	Universal ID that associates Android and iOS versions of the app.
`items.status`	String	Current status of the app (e.g., `NEW`, `PUBLISHED`).
`items.size`	Integer	Size of the app file in bytes.
`items.description`	String	Description of the app.
`items.storagePath`	String	Location where the app is stored.
`items.reason`	String	Reason for the app status, if applicable.
`items.uploadedDate`	String	Date and time the app was uploaded (ISO 8601 format).
`items.metadata`	Object	Metadata associated with the mobile app.
`items.metadata.appId`	String	Identifier for the app.
`items.metadata.identifier`	String	Another identifier for the app, typically used for app store listings.
`items.metadata.name`	String	Name of the app.
`items.metadata.version`	String	Current version of the app.
`items.metadata.versionCode`	String	Internal version code used for identifying builds.
`items.metadata.minSdk`	Integer	Minimum SDK level required to run the app.
`items.metadata.targetSdk`	Integer	Target SDK level for which the app is optimized.
`items.createdDate`	String	Date and time the app record was created (ISO 8601 format).
`items.updatedDate`	String	Date and time the app record was last updated (ISO 8601 format).
`items.fileName`	String	Name of the app file.

Try it!

Enter the required (and optional, if applicable) fields below.
Select the language in Language.
Enter your user name or API credentials.
Review your API call and click Try it!