Request

This request uses POST method, which is used to register a native mobile application in Katalon TestCloud, associating it with a specific organization. Registration enables the application to be managed and utilized within the organization's testing environment.

In the Authorization header, enter your JSON Web Token (JWT) as shown in the example below. For more information on how to obtain one, see JSON Web Token Authentication.
You can use the following filter query commands:
- organizationId to filter data to return apps linked to the provided organization ID.
- pageToken to indicate the page number for pagination.
- size to specify the number of records to return.
- sort to sort the results by ascending or descending order.
You need to provide the following required parameters in the request body:
- storagePath: The unique identifier for the application's storage location within Katalon's system. This is typically a UUID provided upon uploading the application.
- fileName: The name of the application file, including its extension (e.g., app.apk for Android or app.ipa for iOS).
- organizationId: The numeric ID of the organization to which the application should be associated.

For example:

curl --location 'https://testcloud.katalon.com/ees/apps' \
--header 'authorization: Bearer [JWT_TOKEN]' \
--header 'Content-Type: application/json' \
--data '{
    "storagePath": "56698de6-23a2-414d-85dd-2930dd45c1c4",
    "fileName": "tcapp.apk",
    "organizationId": 112
}'

Response

The response returns detailed information about a specific mobile app, including metadata, upload status, size, and more.

See the following example:

{
    "appId": "12345",
    "appName": "app.apk",
    "organizationId": 112,
    "status": "registered",
    "createdDate": "2025-02-11T15:12:21Z"
}

Refer to the following table about the response body properties:

Property	Type	Description
`appId`	Integer	The app ID.
`appName`	String	The app name.
`organizationId`	Integer	The organization ID.
`status`	String	Status (ex. `registered`).
`createdDate`	Integer	Date, time when the app was created.

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!