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

get

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

Recommended approach for retrieving all apps.

Authorizations
Query parameters
nextKeystringOptional

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

Example: xyz
Responses
200
OK
application/json
get
GET /v1/apps HTTP/1.1
Host: api.appetize.io
X-API-KEY: YOUR_API_KEY
Accept: */*
200

OK

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

get

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.

Authorizations
Responses
200
OK
application/json
get
GET /v1/apps/all HTTP/1.1
Host: api.appetize.io
X-API-KEY: YOUR_API_KEY
Accept: */*
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"
    }
  ]
}

Get a Single App

get

Retrieves information about a single app.

Authorizations
Path parameters
publicKeystringRequired

The publicKey for the app.

Example: p7nww3n6ubq73r1nh9jtauqy8w
Responses
200
OK
application/json
get
GET /v1/apps/{app_publicKey} HTTP/1.1
Host: api.appetize.io
X-API-KEY: YOUR_API_KEY
Accept: */*
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"
}

App Groups

Get an App Group

get

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

Authorizations
Path parameters
publicKeystringRequired

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

Example: ag_{publicKey}
Responses
200
OK
application/json
get
GET /v1/apps/{appgroup_publicKey} HTTP/1.1
Host: api.appetize.io
X-API-KEY: YOUR_API_KEY
Accept: */*
200

OK

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

Last updated