List App Lists

📘

GET https://api.kayzen.io/v1/app_lists

Use this API to get the list of all the existing App Lists

See below for supported URL params

FieldParamRequired/ OptionalDescription
advertiser_idintrequiredAdvertiser ID
qstringoptionalSearch query parameter. The result will contain App Lists whose name contains this value
page intoptionalPage number, e.g., if per_page parameter were 50, page number 2 would mean App Lists 51-100
Default Value = 1
per_page intoptionalSet number of App Lists per page.
Default Value = 20 entries
sort_fieldstringoptionalSort App Lists by this field. Possible values:
- id
- name
- components_count
- whitelist_campaigns_count
- blacklist_campaigns_count
- updated_at
Default Value = id
sort_direction asc/descoptionalSort App Lists in ascending or descending order.
Default value 'desc' order
curl -X GET \
'https://api.kayzen.io/v1/app_lists?advertiser_id=98219&q=hypercasual&page=1&per_page=25&sort_direction=desc&sort_field=id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN'
{  
  "data":[  
    {
      "id": 9101,
      "name": "Hypercasual Apps",
      "description": "These are the top hypercasual apps",
      "user_email": "[email protected]",
      "components_count": 20,
      "whitelist_campaigns_count": 0,
      "blacklist_campaigns_count": 0,
      "updated_at": "2023-02-16T10:59:06.000Z"
    }
  ],
  "meta":{  
    "current_page":1,
    "total_pages":1,
    "total_entries":1
  }
}

See below for the response codes

HTTP Status CodeResponse
Success200JSON body with the keys "meta" and "data".

meta will have current_page, total_enteries, and total_pages.

data will be an array of App Lists