---
updatedAt: 2026-05-28T09:43:07.000Z
agentTools:
  projectIndex: https://developers.piwik.pro/llms.txt
---

# Apps list

Get list of apps<br><br>
Full example:
```
/api/apps/v2?offset=100&limit=10&sort=name&search=nifty+marketing&permission=view
```
this will list 10 apps ordered ascending by `name` starting on 101th matching search query "nifty marketing".


# OpenAPI definition

````json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Web API",
    "version": "master"
  },
  "servers": [
    {
      "url": "https://{account}.piwik.pro",
      "variables": {
        "account": {
          "default": "example"
        }
      }
    }
  ],
  "security": [
    {
      "OAuth2ClientCredentials": []
    }
  ],
  "paths": {
    "/api/apps/v2": {
      "get": {
        "summary": "Apps list",
        "description": "Get list of apps<br><br>\nFull example:\n```\n/api/apps/v2?offset=100&limit=10&sort=name&search=nifty+marketing&permission=view\n```\nthis will list 10 apps ordered ascending by `name` starting on 101th matching search query \"nifty marketing\".\n",
        "operationId": "api_app_list_v2",
        "parameters": [
          {
            "in": "query",
            "name": "offset",
            "description": "Sets offset for list of items",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          },
          {
            "in": "query",
            "name": "limit",
            "description": "Limits the number of returned items",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000,
              "default": 10
            }
          },
          {
            "name": "search_query",
            "in": "query",
            "description": "(deprecated) Use `search` param instead",
            "required": false,
            "schema": {
              "type": "string",
              "default": ""
            }
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Sort field - can be reversed by adding dash before field name e.g (-name)",
            "required": false,
            "schema": {
              "type": "string",
              "default": "-addedAt",
              "enum": [
                "name",
                "addedAt",
                "updatedAt",
                "-name",
                "-addedAt",
                "-updatedAt"
              ]
            }
          },
          {
            "name": "search",
            "in": "query",
            "description": "App search query",
            "required": false,
            "schema": {
              "type": "string",
              "default": ""
            }
          },
          {
            "name": "permission",
            "in": "query",
            "description": "Filter apps by permission (actually by an `action`)",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "view",
                "edit",
                "publish",
                "manage"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "meta": {
                      "type": "object",
                      "properties": {
                        "total": {
                          "type": "integer",
                          "description": "Total count of objects",
                          "example": 1
                        }
                      }
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "description": "Resource type",
                            "enum": [
                              "ppms/app"
                            ],
                            "type": "string"
                          },
                          "id": {
                            "type": "string",
                            "description": "Resource ID",
                            "example": "985ed9d7-b652-47b8-b9cf-c17d62735261",
                            "format": "uuid"
                          },
                          "attributes": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string",
                                "description": "App name",
                                "maxLength": 90,
                                "example": "AppName"
                              },
                              "addedAt": {
                                "type": "string",
                                "description": "When app was added",
                                "example": "2018-07-10T08:50:41+00:00",
                                "format": "date-time"
                              },
                              "updatedAt": {
                                "type": "string",
                                "description": "When app was edited",
                                "example": "2018-09-01T10:25:11+00:00",
                                "format": "date-time"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Apps"
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "OAuth2ClientCredentials": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "/auth/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "x-api-checksum": "f30b118d8e5a9d203105c80d9cf4000e1fd797fefe12353beea7e379e41e6e6c"
}
````