Request

This request uses the GET method, which is used to retrieve a paginated list of mobile apps with their metadata associated with a specific organization. This lets users view and manage the applications uploaded to their organization's TestCloud environment.

Enter the information as shown in the example below:

{{subdomain}}: Your subdomain name
x-project-id: Your Project ID
In the Authorization header, replace YOUR_JWT with your JSON Web Token (JWT). For information on how to obtain one, see JSON Web Token Authentication.

Example

curl 'https://{{subdomain}}.katalon.com/v2/tc/ees/apps?q=organizationId%3D%3D323485&pageToken=0&size=30&sort=updatedDate+desc' \
  -H 'authority: testcloud.katalon.com' \
  -H 'x-project-id: 12345'
  -H 'accept: application/json, text/plain, */*' \
  -H 'accept-language: en-US,en;q=0.9' \
  -H 'authorization: Bearer YOUR_JWT' \
  --compressed

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.
size: The number of application records to return per page.
sort: Sorts the results by using a specific sorting field.

Response

A successful response returns a JSON object containing a list of mobile applications that match the specified query parameters. Each application object typically includes details such as the application's ID, name, version, and the date it was last updated.

See the following example:

{
    "count": 31,
    "pageToken": "0",
    "items": [
        {
            "id": "00185b37-53cb-4cea-b5d7-95c9dcd55e3d",
            "organizationId": "278985",
            "name": "TC App",
            "platform": "android",
            "status": "READY",
            "size": 3413991,
            "storagePath": "7d839910-48a9-4686-90ee-dd2e4710d29a",
            "uploadedDate": "2022-10-25T04:37:22Z",
            "metadata": {
                "appUri": "storage:17c65e8f-0511-4c0a-819c-f3ab798b6814",
                "identifier": "com.katalon.testcloud.tcapp",
                "name": "TC App",
                "version": "1.0",
                "minSdk": 21,
                "targetSdk": 32
            },
            "createdDate": "2022-10-25T04:37:20.102617",
            "updatedDate": "2022-10-25T04:37:22.870772",
            "fileName": "tcapp.apk"
        }
    ]
]

Refer to the following table about the response body properties:

Property	Type	Description
`count`	Integer	Number of native apps under the identified organization.
`pageToken`	Integer	Indicates the number of paginated results.
`items`	Object	Object property containing mobile app metadata for the identified organization.
`id`	Integer	The mobile app ID.
`organizationId`	Integer	The organization ID.
`name`	String	The app name.
`platform`	String	The platform name.
`status`	String	Status of the mobile app (`NEW`, `UPLOADING`, `READY`, `ERROR`)
`size`	Integer	The file size.
`storagePath`	Integer	The storage path in S3. See Request URL to upload mobile app.
`metadata`	Object	Mobile app metadata.
`metadata.appUri`	Integer	The application ID.
`metadata.identifier`	String	The iOS app bundle identifier or the Android app application ID.
`metadata.name`	String	The app name.
`metadata.version`	String	The app version.
`metadata.minSdk`	Integer	The min SDK on Android.
`metadata.tartgetSdk`	Integer	The target SDK on Android.

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!

200OK

400Bad request

403Unauthorized

500Internal server error