[Tenjin API Reference](https://api-docs.tenjin.com/llms.txt) › [Campaign Management API](https://api-docs.tenjin.com/campaign-management-api.md) › List apps

- Campaign Management API OpenAPI spec: https://api-docs.tenjin.com/openapi/campaign-management-api.json

# List apps

- **Method:** `GET`
- **Path:** `/v2/apps`
- **Operation ID:** `get_apps`
- **Tags:** Apps

## Effective servers

- `https://api.tenjin.com`

## Authentication

- **Bearer**: HTTP bearer (`JWT`)

  Generate an access token on the [Access Tokens](https://dashboard.tenjin.com/dashboard/access_tokens) page of the Tenjin dashboard and send it as `Authorization: Bearer <access token>`. [API access tokens](https://tenjin.com/docs/api-access-tokens/) explains them.

## Query parameters

- **`query`**: `string`

  Search apps by name
- **`page`**: `integer`, default: `1`

  Page of results to fetch.
- **`per_page`**: `integer`, default: `25`, minimum: `0`, maximum: `1000`

  Number of results to return per page.

## Responses

### 200 Apps

**Headers:**

- **`Link`**

  URLs of the first, previous, next and last pages (RFC 8288); sent only when the list has more than one page

  `string`
- **`Total`**

  Number of items on all pages

  `integer`
- **`Per-Page`**

  Number of items per page

  `integer`

**Content type:** `application/json`

schema: `AppListDocument`

- **`data` (required)**: `array`

  **Items:**

  schema: `AppResource`
  - **`attributes` (required)**: `object`
    - **`amazon_shared_secret` (required)**: `string | null`

      Amazon Appstore shared key, used to validate in-app purchases
    - **`bundle_id` (required)**: `string | null`

      Bundle id of the app in its store
    - **`created_at` (required)**: `string | null`, format: `date-time`

      When the app was added to Tenjin
    - **`deterministic_click_attribution_window` (required)**: `string`

      Duration literal: `0`, whole hours `1h` to `24h`, or whole days `1d` to `30d`. A whole number of days is returned in days, so `24h` comes back as `1d`
    - **`deterministic_impression_attribution_window` (required)**: `string`

      Duration literal: `0`, whole hours `1h` to `24h`, or whole days `1d` to `30d`. A whole number of days is returned in days, so `24h` comes back as `1d`
    - **`developer_name` (required)**: `string | null`

      Name of the app developer
    - **`facebook_referrer_decryption_key` (required)**: `string | null`

      Meta install referrer decryption key, used to decrypt Meta attribution data of an Android app
    - **`ios_shared_secret` (required)**: `string | null`

      App Store shared secret, used to track subscription revenue
    - **`match_strings` (required)**: `array of string`

      Strings that match campaigns to the app
    - **`name` (required)**: `string | null`

      Name of the app
    - **`platform` (required)**: `string | null`, possible values: `"amazon", "android", "android_other", "ios", "windows", "unspecified", null`

      Platform of the app
    - **`price` (required)**: `integer | null`, minimum: `0`

      Price of the app in its store
    - **`probabilistic_click_attribution_window` (required)**: `string`

      Duration literal: `0`, whole hours `1h` to `24h`, or whole days `1d` to `3d`. A whole number of days is returned in days, so `24h` comes back as `1d`
    - **`probabilistic_impression_attribution_window` (required)**: `string`

      Duration literal: `0`, whole hours `1h` to `24h`, or whole days `1d` to `3d`. A whole number of days is returned in days, so `24h` comes back as `1d`
    - **`protocol` (required)**: `string | null`

      URL scheme of the app, used for Meta deep links
    - **`public_key` (required)**: `string | null`

      Google Play public key, used to validate in-app purchases
    - **`rating` (required)**: `string | null`, pattern: `^\d\.\d$`

      Rating of the app in its store: a decimal number as a string
    - **`released_on` (required)**: `string | null`, format: `date`

      Release date of the app in its store
    - **`sending_events` (required)**: `boolean`

      Whether Tenjin has received events of the app
    - **`store_id` (required)**: `string | null`

      Id of the app in its store
  - **`id` (required)**: `string`, format: `uuid`
  - **`type` (required)**: `string`, possible values: `"app"`
- **`links` (required)**: `object`, schema: `Links`
  - **`self` (required)**: `string`, format: `uri`

    URL of this request
  - **`first`**: `string`, format: `uri`

    URL of the first page of a list
  - **`last`**: `string`, format: `uri`

    URL of the last page of a list
  - **`next`**: `string`, format: `uri`

    URL of the next page of a list
  - **`prev`**: `string`, format: `uri`

    URL of the previous page of a list
- **`meta` (required)**: `object`, schema: `PageMeta`
  - **`count` (required)**: `integer`

    Number of items on all pages
  - **`per_page` (required)**: `integer`

    Number of items per page

**Example: Apps**

```json
{
  "data": [
    {
      "id": "e55c55ae-db64-40ad-a711-8bb3885b9581",
      "type": "app",
      "attributes": {
        "name": "Another App",
        "bundle_id": "com.this.AnotherApp",
        "platform": "ios",
        "public_key": "abc123456",
        "ios_shared_secret": null,
        "store_id": "123445678",
        "released_on": "2017-10-03",
        "rating": "2.0",
        "price": 0,
        "developer_name": "Tenjin",
        "match_strings": [],
        "protocol": null,
        "facebook_referrer_decryption_key": null,
        "created_at": "2018-05-22T21:50:20.591Z",
        "sending_events": true,
        "amazon_shared_secret": null,
        "deterministic_click_attribution_window": "1d",
        "deterministic_impression_attribution_window": "1d",
        "probabilistic_click_attribution_window": "1d",
        "probabilistic_impression_attribution_window": "1d"
      }
    },
    {
      "id": "5fce6a93-877c-44f7-9c56-3bfe4acbbfd5",
      "type": "app",
      "attributes": {
        "name": "Dog Watcher",
        "bundle_id": "com.this.DogWatcher",
        "platform": "ios",
        "public_key": null,
        "ios_shared_secret": "3f3ff9gia1fafafab-afds",
        "store_id": "123445678",
        "released_on": "2017-10-03",
        "rating": "4.3",
        "price": 99,
        "developer_name": "Tenjin",
        "match_strings": [],
        "protocol": "fb190003007235028",
        "facebook_referrer_decryption_key": "2575590594a9cd809e5bfacf397f8c1ac730dbc38a3e137ecd1ab66591c8c3c9",
        "created_at": "2019-05-22T21:50:20.591Z",
        "sending_events": true,
        "amazon_shared_secret": null,
        "deterministic_click_attribution_window": "1d",
        "deterministic_impression_attribution_window": "1d",
        "probabilistic_click_attribution_window": "1d",
        "probabilistic_impression_attribution_window": "1d"
      }
    }
  ],
  "links": {
    "self": "https://api.tenjin.com/v2/apps"
  },
  "meta": {
    "count": 2,
    "per_page": 25
  }
}
```

### 400, 401, 403, 498

- `400` A param is missing or invalid, a record is not found, or the request cannot be served
- `401` Missing or invalid credentials, or no access to the requested data
- `403` Invalid token, or the user's role does not allow the request
- `498` Expired token, or a token with an invalid signature

**Content type:** `application/json`

schema: `Error`

- **`error` (required)**: `string`

  What went wrong

**Example:**

```json
{
  "error": ""
}
```

## Schemas

- `Error` — shown above.
- `AppListDocument` — shown above.
- `Links` — shown above.
- `PageMeta` — shown above.
- `AppResource` — shown above.