App Lists

GET accounts/:account_id/app_lists

Retrieve details for some or all app lists associated with the current account.

Resource URL

https://ads-api.twitter.com/8/accounts/:account_id/app_lists

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

app_list_ids
optional

Scope the response to just the desired app lists by specifying a comma-separated list of identifiers. Up to 200 IDs may be provided.

Type: string

Example: wm7x

count
optional

Specifies the number of records to try and retrieve per distinct request.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional

Specifies a cursor to get the next page of results. See Pagination for more information.

Type: string

Example: 8x7v00oow

sort_by
optional

Sorts by supported attribute in ascending or descending order. See Sorting for more information.

Type: string

Example: created_at-asc

with_deleted
optional

Include deleted results in your request.

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional

Include the total_count response attribute.

Note: This parameter and cursor are exclusive.

Note: Requests which include total_count will have lower rate limits, currently set at 200 per 15 minutes.

Type: boolean

Default: false
Possible values: true, false

Example Request

GET https://ads-api.twitter.com/8/accounts/18ce54d4x5t/app_lists?app_list_ids=wm7x

Example Response

{
  "request": {
    "params": {
      "app_list_ids": [
        "wm7x"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "id": "wm7x",
      "name": "foo @ 14026528192426843"
    }
  ]
}

GET accounts/:account_id/app_lists/:app_list_id

Retrieve a specific app list associated with the current account.

Resource URL

https://ads-api.twitter.com/8/accounts/:account_id/app_lists/:app_list_id

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

app_list_id
required

A reference to the app list you are operating with in the request.

Type: string

Example: 28ukf

with_deleted
optional

Include deleted results in your request.

Type: boolean

Default: false
Possible values: true, false

Example Request

GET https://ads-api.twitter.com/8/accounts/18ce54d4x5t/app_lists/28ukf

Example Response

{
  "data": {
    "name": "twitter @ 262689209670784",
    "id": "28ukf",
    "created_at": "2017-08-17T17:07:42Z",
    "updated_at": "2017-08-17T17:07:42Z",
    "deleted": false,
    "apps": [
      {
        "app_store_identifier": "com.twitter.android",
        "os_type": "Android"
      }
    ]
  },
  "request": {
    "params": {
      "app_list_id": "28ukf",
      "account_id": "18ce54d4x5t"
    }
  }
}

POST accounts/:account_id/app_lists

Create an app_list associated with the current account.

Currently there is a limit of 100 app_list objects per account_id and 500 apps per app_list.

Resource URL

https://ads-api.twitter.com/8/accounts/:account_id/app_lists

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

app_store_identifiers
required

The app store identifiers to include in the app_list

Type: string

Example: com.twitter.android

name
required

The name you will assign to the app_list

Type: string

Example: My First App List

Example Request

POST https://ads-api.twitter.com/8/accounts/18ce54d4x5t/app_lists?name=app list&app_store_identifiers=com.twitter.android

Example Response

{
  "data": {
    "name": "app list",
    "id": "2a4um",
    "created_at": "2017-09-06T07:17:26Z",
    "updated_at": "2017-09-06T07:17:26Z",
    "deleted": false,
    "apps": [
      {
        "app_store_identifier": "com.twitter.android",
        "os_type": "Android"
      }
    ]
  },
  "request": {
    "params": {
      "app_store_identifiers": [
        "com.twitter.android"
      ],
      "name": "app list",
      "account_id": "18ce54d4x5t"
    }
  }
}

DELETE accounts/:account_id/app_lists/:app_list_id

Delete the specified app list associated with the current account.

Resource URL

https://ads-api.twitter.com/8/accounts/:account_id/app_lists/:app_list_id

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

app_list_id
required

A reference to the app list you are operating with in the request.

Type: string

Example: 28ukf

Example Request

DELETE https://ads-api.twitter.com/8/accounts/18ce54d4x5t/app_lists/28ukf

Example Response

{
  "data": {
    "name": "twitter @ 262689209670784",
    "id": "28ukf",
    "created_at": "2017-08-17T17:07:42Z",
    "updated_at": "2017-09-12T22:20:33Z",
    "deleted": true,
    "apps": [
      {
        "app_store_identifier": "com.twitter.android",
        "os_type": "Android"
      }
    ]
  },
  "request": {
    "params": {
      "app_list_id": "28ukf",
      "account_id": "18ce54d4x5t"
    }
  }
}

Was this document helpful?

Thank you

Thank you for the feedback. We’re really glad we could help!

Thank you for the feedback. How could we improve this document?

Thank you for the feedback. Your comments will help us improve our documents in the future.