At a glance: Retrieve active and pending apps associated with your AppsFlyer account.
If you are an ad network, use the app list for ad networks API.
Further reading: API list for advertisers
Get app list API
The following sections include information necessary for using the API.
Get app list basics
Get API list basics
Category | Item |
Description |
---|---|---|
Request | HTTP method | GET |
Path |
https://hq1.appsflyer.com/api/mng/apps |
|
Authorization header |
|
|
Response |
Results |
Return in a JSON |
Request limit |
|
|
Record limit |
1,000 records/request. If more than 1,000 records are to return, use follow-on pagination requests described in this article. |
API request
The API request consists of the method, path, mandatory capabilities parameter, and optional pagination parameters. The token is contained in the authorization header.
Method
GET https://hq1.appsflyer.com/api/mng/apps
Get app list mandatory parameters:
Query parameter |
Description |
---|---|
There are no mandatory query parameters for this API |
Pagination mechanism
A pagination mechanism, always operational, is implemented.
Pagination principles:
- Returns up to 1,000 records per request (page).
- Response JSONs contain the following pagination related keys:
- meta.total_items: The number of records to be returned by all pages combined. This represents the number of apps for which you have been granted the capabilities being queried.
- Pagination links (depicted in the JSON that follows) have the following keys:
- links.prev: If there was a previous request: the request used to generate the previous page.
- links.self: The current request: the request used to generate the current JSON (page)
- links.next: The request required to get the next page. If there is no next key, this is the last page.
Use one of the following pagination control methods:
- [Best practice] Use the links in the JSON: If the links.next key exists, use it to create a request to get the next page. Continue to do so until you receive a JSON without a links.next key.
- Programatically implement limit and offset parameters in conjunction with the total_items key.
Pagination links JSON example
- The example that follows contains the result of the second request, consisting of two records in the data section (not displayed).
- The total number of records to return is 6.
- The links.next key contains the request that returns the second page—records 5 and 6.
{
"data": {[...]},
"meta": {
"total_items": 6
},
"links": {
"prev": "https://hq1.appsflyer.com/api/mng/apps?offset=0&limit=2",
"self": "https://hq1.appsflyer.com/api/mng/apps?offset=2&limit=2",
"next": "https://hq1.appsflyer.com/api/mng/apps?offset=4&limit=2"
}
}
Pagination mechanism parameters (optional):
Query parameter |
Description |
---|---|
limit |
Number of records that return per call
|
offset |
The first record to return in the call. Record numbers start with 0.
|
JSON response
Key |
Description |
---|---|
id |
App ID, for example: |
type |
Always return app |
name |
App name |
platform |
iOS or Android |
currency |
App-specific currency code |
time_zone |
App-specific timezone |
total_items |
Number of apps housed in the account |
links |
Pagination mechanism (explained in the parameters section)
|
Get app list cURL example and response
CURL request
This example includes a complete call, including optional pagination parameters.
cURL --location --request GET 'https://hq1.appsflyer.com/api/mng/apps?limit=1000&offset=0' \
-H 'Authorization: Bearer {API V2.0 token having more than 700 characters available to the admin in the dashboard.}' \
JSON response
{
"data": [
{
"id": "com.appsflyer.xpend_qa1",
"type": "app",
"attributes": {
"name": "com.appsflyer.xpend_qa1",
"platform": "android",
"currency": "USD",
"time_zone": "UTC"
}
},
{
"id": "com.abc.app",
"type": "app",
"attributes": {
"name": "com.abc.app",
"platform": "android",
"currency": "USD",
"time_zone": "UTC",
"enable_retargetting": true
}
},
{
"id": "com.def.app",
"type": "app",
"attributes": {
"name": "com.def.app",
"platform": "android",
"currency": "JPY",
"time_zone": "UTC"
}
}
],
"meta": {
"total_items": 6
},
"links": {
"self": "https://hq1.appsflyer.com/api/mng/apps?offset=0&limit=1000"
}
}
HTTP response codes
Code |
Message |
Remarks/troubleshooting |
---|---|---|
200 | OK |
Valid data returned |
200 | OK |
Symptom: No data returns Action: Make sure the authentication token is in the bearer header. |
400 | Bad request |
See the message contained in the JSON |
401 | Unauthorized |
Message: Authorization token is malformed Make sure you have the correct token; token must have 700+ characters. |
404 | Not found |
|
429 | Too many requests |
Exceeded rate limitation |