List apps

Apps

The returned app(s) will display only explicitly set parameters, with all other values defaulting to the account or Appetize defaults.

Get a Single App

GET https://[e-mail]/v1/apps/:publicKey

Retrieves information about a single app.

Path Parameters

Name	Type	Description
publicKey*	string	publicKey for the app

200: OK

{
    "publicKey": "p7nww3n6ubq73r1nh9jtauqy8w",
    "created": "2016-02-10T17:46:14.089Z",
    "updated": "2016-02-10T17:46:14.089Z",
    "platform": "ios",
    "bundle": "com.example.app",
    "name": "example",
    "appDisplayName": "Example App",
    "appVersionCode": "1",
    "appVersionName": "1.0.0",
    "versionCode": 1,
    "iconUrl": "https://example.com/app.png",
}

Get All Apps - Paginated

GET https://[e-mail]/v1/apps

Retrieves information about all apps in the account, with associated metadata.

Recommended approach for retrieving all apps.

Query Parameters

Name	Type	Description
nextKey	string	If results are truncated due to too many apps, response will include hasMore: true and nextKey: "xyz" . Pass nextKey value as query parameter into GET request to retrieve the next batch of apps.

200: OK

{
    "hasMore": true, // if results have been truncated
    "nextKey": "xyz", // query parameter for next batch of results
    "data": [{
        "publicKey": "p7nww3n6ubq73r1nh9jtauqy8w",
        "created": "2016-02-10T17:46:14.089Z",
        "updated": "2016-02-10T17:46:14.089Z",
        "platform": "ios",
        "bundle": "com.example.app",
        "name": "example",
        "appDisplayName": "Example App",
        "appVersionCode": "1",
        "appVersionName": "1.0.0",
        "versionCode": 1,
        "iconUrl": "https://example.com/app.png",
    }, {
        "publicKey": "48g0593mgxut2fz57yw2hdjd24",
        "created": "2016-02-10T17:44:38.613Z",
        "updated": "2016-02-10T17:44:38.613Z",
        "platform": "ios",
        "bundle": "com.example.app2",
        "name": "example",
        "appDisplayName": "Example App",
        "appVersionCode": "1",
        "appVersionName": "1.0.0",
        "versionCode": 3,
        "iconUrl": "https://example.com/app2.png",
    }]
}

Get All Apps - Not Paginated

GET https://[e-mail]/v1/apps/all

Retrieves information about all apps in the account, with associated metadata.

NOTE: No pagination is performed so this query might be slow. It is recommended to use the paginated version of this query if possible.

200: OK

{
    "data": [{
        "publicKey": "p7nww3n6ubq73r1nh9jtauqy8w",
        "created": "2016-02-10T17:46:14.089Z",
        "updated": "2016-02-10T17:46:14.089Z",
        "platform": "ios",
        "bundle": "com.example.app",
        "name": "example",
        "appDisplayName": "Example App",
        "appVersionCode": "1",
        "appVersionName": "1.0.0",
        "versionCode": 1,
        "iconUrl": "https://example.com/app.png",
    }, {
        "publicKey": "48g0593mgxut2fz57yw2hdjd24",
        "created": "2016-02-10T17:44:38.613Z",
        "updated": "2016-02-10T17:44:38.613Z",
        "platform": "ios",
        "bundle": "com.example.app2",
        "name": "example",
        "appDisplayName": "Example App",
        "appVersionCode": "1",
        "appVersionName": "1.0.0",
        "versionCode": 3,
        "iconUrl": "https://example.com/app2.png",
    }]
}

App Groups

Get an App Group

GET https://[e-mail]/v1/apps/:publicKey

Retrieves information about an app group and all the apps associated with it.

Path Parameters

Name	Type	Description
publicKey*	string	publicKey for the app group (starts with ag_)

200: OK

{
    "publicKey": "ag_{publicKey}",
    "updated": "2023-07-21T12:50:21.492Z",
    "name": "App Group Name",
    "created": "2023-05-05T08:35:39.967Z",
    "createdBy": "[e-mail]",
    "apps": [
        "{app 1 publicKey}",
        "{app 2 publicKey}"
    ]
}