App Groups

List App Groups

get

List all app groups in the account, with associated metadata.

Authorizations

jwtapiToken

Query parameters

pageintegerOptional

The page number of results

Example: 1

limitintegerOptional

The number of results to return per page

Example: 10

searchstringOptional

The search term to filter by

Example: My App

platformstring · enumOptional

The platform to filter by

Example: iosPossible values:

createdstring · date-timeOptional

The created date to filter by

Example: 2020-01-01T00:00:00.000Z

updatedstring · date-timeOptional

The updated date to filter by,

Example: 2020-01-01T00:00:00.000Z

Responses

200

OK

application/json

totalinteger · int32OptionalExample: 25

nextPagenumber · int32 · nullableOptionalExample: 2

400

Bad Request

application/json

401

Unauthorized

application/json

get/v2/app-groups

HTTPcURLJavaScriptPython

GET /v2/app-groups HTTP/1.1
Host: api.appetize.io
Accept: */*

{
  "total": 25,
  "nextPage": 2,
  "groups": [
    {
      "id": "ag_utueteiSee9u",
      "name": "My App Group",
      "platform": "ios",
      "created": "2020-01-01T00:00:00.000Z",
      "updated": "2020-01-01T00:00:00.000Z",
      "createdBy": "[e-mail]",
      "updatedBy": "[e-mail]",
      "lastPlayed": "2020-01-01T00:00:00.000Z",
      "apps": [
        {
          "buildId": "b_eeWohT2piec0",
          "appId": "com.sample.appId",
          "versionName": "1.0.0",
          "buildNumber": 1,
          "tags": [
            "latest",
            "beta"
          ]
        }
      ],
      "resolvedBuilds": [
        {
          "id": "b_eeWohT2piec0",
          "appId": "com.sample.appId",
          "platform": "ios",
          "name": "My App",
          "iconUrl": "https://appetize.io/images/icon.png",
          "versionName": "1.0.0",
          "buildNumber": "1",
          "tags": [
            "tag1",
            "tag2"
          ],
          "note": "This is a note",
          "created": "2020-01-01T00:00:00.000Z",
          "createdBy": "[e-mail]",
          "updated": "2020-01-01T00:00:00.000Z",
          "updatedBy": "[e-mail]",
          "lastPlayed": "2020-01-01T00:00:00.000Z",
          "metadata": {
            "android": {
              "packageName": "com.sample.appId",
              "name": "My App",
              "versionName": "1.0.0",
              "versionCode": 22,
              "minSDKVersion": 23,
              "targetSDKVersion": 33,
              "architectures": [
                "arm64"
              ],
              "permissions": [
                "android.permission.INTERNET"
              ],
              "localizations": [
                "en",
                "de",
                "it"
              ]
            }
          }
        }
      ]
    }
  ]
}

Create App Group

post

Create a new app group.

Authorizations

jwtapiToken

Body

application/json

namestringOptional

The name of the App Group.

Example: My App Group

platformstring · enumRequiredExample: iosPossible values:

Responses

201

App Group created

application/json

idstringRequired

The unique identifier for the App Group.

Example: ag_utueteiSee9u

namestringOptional

The name of the App Group.

Example: My App Group

platformstring · enumRequiredExample: iosPossible values:

createdstring · date-timeRequired

The date the app-group was created.

Example: 2020-01-01T00:00:00.000Z

updatedstring · date-timeOptional

The date the app-group was last updated.

Example: 2020-01-01T00:00:00.000Z

createdBystringRequired

The user who created the app group.

Example: [e-mail]

updatedBystringOptional

The user who last updated the app.

Example: [e-mail]

lastPlayedstring · date-timeOptional

The time the app group was last played.

Example: 2020-01-01T00:00:00.000Z

400

Bad Request

application/json

401

Unauthorized

application/json

post/v2/app-groups

HTTPcURLJavaScriptPython

POST /v2/app-groups HTTP/1.1
Host: api.appetize.io
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "name": "My App Group",
  "platform": "ios",
  "apps": [
    {
      "buildId": "b_eeWohT2piec0",
      "appId": "com.sample.appId",
      "versionName": "1.0.0",
      "buildNumber": 1,
      "tags": [
        "latest",
        "beta"
      ]
    }
  ]
}

{
  "id": "ag_utueteiSee9u",
  "name": "My App Group",
  "platform": "ios",
  "created": "2020-01-01T00:00:00.000Z",
  "updated": "2020-01-01T00:00:00.000Z",
  "createdBy": "[e-mail]",
  "updatedBy": "[e-mail]",
  "lastPlayed": "2020-01-01T00:00:00.000Z",
  "apps": [
    {
      "buildId": "b_eeWohT2piec0",
      "appId": "com.sample.appId",
      "versionName": "1.0.0",
      "buildNumber": 1,
      "tags": [
        "latest",
        "beta"
      ]
    }
  ],
  "resolvedBuilds": [
    {
      "id": "b_eeWohT2piec0",
      "appId": "com.sample.appId",
      "platform": "ios",
      "name": "My App",
      "iconUrl": "https://appetize.io/images/icon.png",
      "versionName": "1.0.0",
      "buildNumber": "1",
      "tags": [
        "tag1",
        "tag2"
      ],
      "note": "This is a note",
      "created": "2020-01-01T00:00:00.000Z",
      "createdBy": "[e-mail]",
      "updated": "2020-01-01T00:00:00.000Z",
      "updatedBy": "[e-mail]",
      "lastPlayed": "2020-01-01T00:00:00.000Z",
      "metadata": {
        "android": {
          "packageName": "com.sample.appId",
          "name": "My App",
          "versionName": "1.0.0",
          "versionCode": 22,
          "minSDKVersion": 23,
          "targetSDKVersion": 33,
          "architectures": [
            "arm64"
          ],
          "permissions": [
            "android.permission.INTERNET"
          ],
          "localizations": [
            "en",
            "de",
            "it"
          ]
        }
      }
    }
  ]
}

Get App Group

get

Get an app group by its unique identifier.

Authorizations

jwtapiToken

Path parameters

appGroupIdstringRequired

The unique identifier for the app group.

Example: ag_nbf3wn4d

Responses

200

OK

application/json

idstringRequired

The unique identifier for the App Group.

Example: ag_utueteiSee9u

namestringOptional

The name of the App Group.

Example: My App Group

platformstring · enumRequiredExample: iosPossible values:

createdstring · date-timeRequired

The date the app-group was created.

Example: 2020-01-01T00:00:00.000Z

updatedstring · date-timeOptional

The date the app-group was last updated.

Example: 2020-01-01T00:00:00.000Z

createdBystringRequired

The user who created the app group.

Example: [e-mail]

updatedBystringOptional

The user who last updated the app.

Example: [e-mail]

lastPlayedstring · date-timeOptional

The time the app group was last played.

Example: 2020-01-01T00:00:00.000Z

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get/v2/app-groups/{appGroupId}

HTTPcURLJavaScriptPython

GET /v2/app-groups/{appGroupId} HTTP/1.1
Host: api.appetize.io
Accept: */*

{
  "id": "ag_utueteiSee9u",
  "name": "My App Group",
  "platform": "ios",
  "created": "2020-01-01T00:00:00.000Z",
  "updated": "2020-01-01T00:00:00.000Z",
  "createdBy": "[e-mail]",
  "updatedBy": "[e-mail]",
  "lastPlayed": "2020-01-01T00:00:00.000Z",
  "apps": [
    {
      "buildId": "b_eeWohT2piec0",
      "appId": "com.sample.appId",
      "versionName": "1.0.0",
      "buildNumber": 1,
      "tags": [
        "latest",
        "beta"
      ]
    }
  ],
  "resolvedBuilds": [
    {
      "id": "b_eeWohT2piec0",
      "appId": "com.sample.appId",
      "platform": "ios",
      "name": "My App",
      "iconUrl": "https://appetize.io/images/icon.png",
      "versionName": "1.0.0",
      "buildNumber": "1",
      "tags": [
        "tag1",
        "tag2"
      ],
      "note": "This is a note",
      "created": "2020-01-01T00:00:00.000Z",
      "createdBy": "[e-mail]",
      "updated": "2020-01-01T00:00:00.000Z",
      "updatedBy": "[e-mail]",
      "lastPlayed": "2020-01-01T00:00:00.000Z",
      "metadata": {
        "android": {
          "packageName": "com.sample.appId",
          "name": "My App",
          "versionName": "1.0.0",
          "versionCode": 22,
          "minSDKVersion": 23,
          "targetSDKVersion": 33,
          "architectures": [
            "arm64"
          ],
          "permissions": [
            "android.permission.INTERNET"
          ],
          "localizations": [
            "en",
            "de",
            "it"
          ]
        }
      }
    }
  ]
}

Delete App Group

delete

Delete an app group by its unique identifier.

Authorizations

jwtapiToken

Path parameters

appGroupIdstringRequired

The unique identifier for the app group.

Example: ag_nbf3wn4d

Responses

204

App Group deleted

No content

400

Bad Request

application/json

delete/v2/app-groups/{appGroupId}

HTTPcURLJavaScriptPython

DELETE /v2/app-groups/{appGroupId} HTTP/1.1
Host: api.appetize.io
Accept: */*

No content

Update App Group

patch

Update an app group by its unique identifier.

Authorizations

jwtapiToken

Path parameters

appGroupIdstringRequired

The unique identifier for the app group.

Example: ag_nbf3wn4d

Body

application/json

namestringOptional

The name of the App Group.

Example: My App Group

platformstring · enumRequiredExample: iosPossible values:

Responses

200

OK

application/json

idstringRequired

The unique identifier for the App Group.

Example: ag_utueteiSee9u

namestringOptional

The name of the App Group.

Example: My App Group

platformstring · enumRequiredExample: iosPossible values:

createdstring · date-timeRequired

The date the app-group was created.

Example: 2020-01-01T00:00:00.000Z

updatedstring · date-timeOptional

The date the app-group was last updated.

Example: 2020-01-01T00:00:00.000Z

createdBystringRequired

The user who created the app group.

Example: [e-mail]

updatedBystringOptional

The user who last updated the app.

Example: [e-mail]

lastPlayedstring · date-timeOptional

The time the app group was last played.

Example: 2020-01-01T00:00:00.000Z

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

patch/v2/app-groups/{appGroupId}

HTTPcURLJavaScriptPython

PATCH /v2/app-groups/{appGroupId} HTTP/1.1
Host: api.appetize.io
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "name": "My App Group",
  "platform": "ios",
  "apps": [
    {
      "buildId": "b_eeWohT2piec0",
      "appId": "com.sample.appId",
      "versionName": "1.0.0",
      "buildNumber": 1,
      "tags": [
        "latest",
        "beta"
      ]
    }
  ]
}

{
  "id": "ag_utueteiSee9u",
  "name": "My App Group",
  "platform": "ios",
  "created": "2020-01-01T00:00:00.000Z",
  "updated": "2020-01-01T00:00:00.000Z",
  "createdBy": "[e-mail]",
  "updatedBy": "[e-mail]",
  "lastPlayed": "2020-01-01T00:00:00.000Z",
  "apps": [
    {
      "buildId": "b_eeWohT2piec0",
      "appId": "com.sample.appId",
      "versionName": "1.0.0",
      "buildNumber": 1,
      "tags": [
        "latest",
        "beta"
      ]
    }
  ],
  "resolvedBuilds": [
    {
      "id": "b_eeWohT2piec0",
      "appId": "com.sample.appId",
      "platform": "ios",
      "name": "My App",
      "iconUrl": "https://appetize.io/images/icon.png",
      "versionName": "1.0.0",
      "buildNumber": "1",
      "tags": [
        "tag1",
        "tag2"
      ],
      "note": "This is a note",
      "created": "2020-01-01T00:00:00.000Z",
      "createdBy": "[e-mail]",
      "updated": "2020-01-01T00:00:00.000Z",
      "updatedBy": "[e-mail]",
      "lastPlayed": "2020-01-01T00:00:00.000Z",
      "metadata": {
        "android": {
          "packageName": "com.sample.appId",
          "name": "My App",
          "versionName": "1.0.0",
          "versionCode": 22,
          "minSDKVersion": 23,
          "targetSDKVersion": 33,
          "architectures": [
            "arm64"
          ],
          "permissions": [
            "android.permission.INTERNET"
          ],
          "localizations": [
            "en",
            "de",
            "it"
          ]
        }
      }
    }
  ]
}