List apps

Apps

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

Get All Apps - Paginated

Retrieves information about all apps int he account, with associated metadata.

Recommended approach for retrieving all apps.

GEThttps://api.appetize.io/v1/apps

Query parameters

Response

200

OK

Body

application/json

hasMoreboolean

Indicates if results have been truncated

nextKeystring

Query parameter for the next batch of results

dataarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.appetize.io/v1/apps', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "hasMore": true,
  "nextKey": "xyz",
  "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

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.

GEThttps://api.appetize.io/v1/apps/all

Response

200

OK

Body

application/json

dataarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.appetize.io/v1/apps/all', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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 a Single App

Retrieves information about a single app.

GEThttps://api.appetize.io/v1/apps/{app_publicKey}

Path parameters

publicKey*string

The publicKey for the app.

Example: "p7nww3n6ubq73r1nh9jtauqy8w"

Response

200

OK

Body

application/json

publicKeystring

The publicKey for the app.

createdstring (date-time)

The date and time when the app was created.

updatedstring (date-time)

The date and time when the app was last updated.

platformstring

The platform of the app (ios or android).

bundlestring

The app identifier of the app.

namestring

The name of the app.

appDisplayNamestring

The display name of the app.

appVersionCodestring

The version code of the app.

appVersionNamestring

The version name of the app.

versionCodeinteger

The incremental version code, managed by Appetize, for the app.

iconUrlstring (uri)

The URL to the app's icon image.

Request

JavaScriptCurlPython

const response = await fetch('https://api.appetize.io/v1/apps/{app_publicKey}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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"
}

App Groups

Get an App Group

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

GEThttps://api.appetize.io/v1/apps/{appgroup_publicKey}

Path parameters

publicKey*string

The publicKey for the app group (starts with ag_).

Example: "ag_{publicKey}"

Response

200

OK

Body

application/json

publicKeystring

The publicKey for the app group.

createdstring (date-time)

The date and time when the app group was created.

updatedstring (date-time)

The date and time when the app group was last updated.

createdBystring

The user who created the app group.

namestring

The name of the app group.

appsarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://api.appetize.io/v1/apps/{appgroup_publicKey}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "publicKey": "ag_{publicKey}",
  "name": "App Group Name",
  "created": "2016-02-10T17:46:14.089Z",
  "updated": "2016-02-10T17:46:14.089Z",
  "createdBy": "[e-mail]",
  "apps": [
    "p7nww3n6ubq73r1nh9jtauqy8w",
    "48g0593mgxut2fz57yw2hdjd24"
  ]
}