> ## Documentation Index
> Fetch the complete documentation index at: https://developer.onetrust.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get List of Applications

Use this API to retrieve a paginated list of applications. The search parameter can be used to optionally filter results by name.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Consent & Preferences - Cookie Consent",
    "version": "1.0",
    "contact": {
      "name": "OneTrust Support",
      "url": "https://my.onetrust.com/s/contactsupport"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "description": "The Cookie Consent APIs are used to integrate external systems and streamline the flow of data with Cookie Consent in the OneTrust Platform."
  },
  "servers": [
    {
      "url": "https://{hostname}",
      "variables": {
        "hostname": {
          "default": "hostname",
          "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Applications",
      "description": "The Applications APIs are used to manage application configurations and their associated consent experiences.",
      "externalDocs": {
        "description": "OpenAPI 3.1.0 - Download Definition",
        "url": "https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"
      }
    }
  ],
  "x-onetrust": {
    "spec-label": "OpenAPI 3.1.0"
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "metrics-enabled": false
  },
  "paths": {
    "/api/cmp/v1/applications": {
      "get": {
        "operationId": "getApplications",
        "summary": "Get List of Applications",
        "description": "Use this API to retrieve a paginated list of applications. The search parameter can be used to optionally filter results by name.",
        "tags": [
          "Applications"
        ],
        "parameters": [
          {
            "name": "searchStr",
            "in": "query",
            "description": "Search string to filter applications by name",
            "required": false,
            "schema": {
              "type": "string",
              "maxLength": 255
            },
            "example": "My App"
          },
          {
            "name": "sortBy",
            "in": "query",
            "description": "Field to sort by.",
            "required": false,
            "schema": {
              "type": "string",
              "default": "name",
              "enum": [
                "name",
                "os"
              ]
            },
            "example": "name"
          },
          {
            "name": "direction",
            "in": "query",
            "description": "Sort direction.",
            "required": false,
            "schema": {
              "type": "string",
              "default": "asc",
              "enum": [
                "asc",
                "desc"
              ]
            },
            "example": "asc"
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number (0-based)",
            "required": false,
            "schema": {
              "type": "integer",
              "example": 1,
              "default": 0,
              "minimum": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "Page size",
            "required": false,
            "schema": {
              "type": "integer",
              "example": 10,
              "default": 10,
              "maximum": 100,
              "minimum": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PageApplicationListPublicDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "429": {
            "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).",
            "headers": {
              "Retry-After": {
                "schema": {
                  "description": "The number of seconds after which requests will be allowed again.",
                  "format": "int32"
                }
              },
              "ot-period": {
                "schema": {
                  "description": "The unit of time for which the rate limit applies",
                  "enum": [
                    "HOUR",
                    "MINUTE"
                  ]
                }
              },
              "ot-ratelimit-event-id": {
                "schema": {
                  "description": "The unique identifier for the rate-limiting event.",
                  "format": "uuid"
                }
              },
              "ot-request-made": {
                "schema": {
                  "description": "The number of requests made within the specified period.",
                  "format": "int32"
                }
              },
              "ot-requests-allowed": {
                "schema": {
                  "description": "The number of requests allowed within the specified period.",
                  "format": "int32"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "OAUTH2": [
              "COOKIE_READ"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "PageableObject": {
        "type": "object",
        "properties": {
          "offset": {
            "description": "The starting position for paginated results.",
            "type": "integer",
            "format": "int64"
          },
          "sort": {
            "description": "The sorting configuration applied to the results.",
            "$ref": "#/components/schemas/SortObject"
          },
          "paged": {
            "description": "This flag indicates whether pagination is enabled.",
            "type": "boolean"
          },
          "pageSize": {
            "description": "The number of items displayed per page.",
            "type": "integer",
            "format": "int32"
          },
          "pageNumber": {
            "description": "The current page number in the pagination sequence.",
            "type": "integer",
            "format": "int32"
          },
          "unpaged": {
            "description": "This flag indicates whether pagination is disabled.",
            "type": "boolean"
          }
        }
      },
      "SortObject": {
        "type": "object",
        "properties": {
          "empty": {
            "description": "This flag indicates whether the result set is empty.",
            "type": "boolean"
          },
          "sorted": {
            "description": "This flag indicates whether the results are sorted.",
            "type": "boolean"
          },
          "unsorted": {
            "description": "This flag indicates whether the results are in unsorted order.",
            "type": "boolean"
          }
        }
      },
      "ApplicationListPublicDto": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Unique identifier of the application",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "name": {
            "description": "Name of the application",
            "type": "string",
            "example": "My Mobile App",
            "maxLength": 255,
            "minLength": 1
          },
          "os": {
            "description": "Operating system type",
            "type": "string",
            "example": "ANDROID",
            "enum": [
              "IOS",
              "ANDROID",
              "APPLETV",
              "ANDROIDTV",
              "FIRETV",
              "ROKU",
              "SAMSUNGTV",
              "LGTV",
              "VIZIOTV",
              "HBBTV",
              "PANASONICTV",
              "PS5",
              "YOUVIEW"
            ]
          },
          "status": {
            "description": "Current scan status of the application",
            "type": "string",
            "example": "COMPLETED",
            "enum": [
              "PENDING",
              "PROGRESS",
              "COMPLETED",
              "FAILED",
              "INTERRUPTED"
            ]
          },
          "publishStatus": {
            "description": "Publish status of the application",
            "type": "string",
            "example": "PUBLISHED",
            "enum": [
              "DRAFT",
              "PUBLISHED",
              "PUBLISHING",
              "FAILED",
              "WAITING"
            ]
          },
          "consentPolicyId": {
            "description": "Consent policy ID assigned to this application",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "consentPolicyName": {
            "description": "Name of the assigned consent policy",
            "type": "string",
            "example": "GDPR Policy",
            "maxLength": 255,
            "minLength": 1
          },
          "consentPolicyAssignDate": {
            "description": "Date when consent policy was assigned",
            "type": "string",
            "format": "date-time",
            "example": "2024-01-15T10:30:00Z"
          },
          "orgId": {
            "description": "Organization ID that owns this application",
            "type": "string",
            "example": "org-123"
          },
          "orgName": {
            "description": "Organization name",
            "type": "string",
            "example": "OneTrust",
            "maxLength": 255,
            "minLength": 1
          },
          "scriptVersion": {
            "description": "Script version",
            "type": "string",
            "example": "202603.1.0",
            "maxLength": 100
          },
          "createdDate": {
            "description": "Date when the application was created",
            "type": "string",
            "format": "date-time",
            "example": "2024-01-01T10:00:00Z"
          },
          "modifiedDate": {
            "description": "Date when the application was last modified",
            "type": "string",
            "format": "date-time",
            "example": "2024-01-15T10:30:00Z"
          },
          "publishedDate": {
            "description": "Date when the application was last published",
            "type": "string",
            "format": "date-time",
            "example": "2024-01-10T10:00:00Z"
          }
        }
      },
      "PageApplicationListPublicDto": {
        "type": "object",
        "properties": {
          "totalPages": {
            "type": "integer",
            "format": "int32"
          },
          "totalElements": {
            "type": "integer",
            "format": "int64"
          },
          "size": {
            "type": "integer",
            "format": "int32"
          },
          "content": {
            "items": {
              "$ref": "#/components/schemas/ApplicationListPublicDto"
            },
            "type": "array"
          },
          "number": {
            "type": "integer",
            "format": "int32"
          },
          "sort": {
            "$ref": "#/components/schemas/SortObject"
          },
          "pageable": {
            "$ref": "#/components/schemas/PageableObject"
          },
          "first": {
            "type": "boolean"
          },
          "last": {
            "type": "boolean"
          },
          "numberOfElements": {
            "type": "integer",
            "format": "int32"
          },
          "empty": {
            "type": "boolean"
          }
        }
      }
    },
    "securitySchemes": {
      "OAUTH2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://{hostname}/api/access/v1/oauth/token",
            "scopes": {
              "COOKIE": "Cookie Scope gives the user access to read/write operations inside the Cookie Consent module.",
              "COOKIE_READ": "Cookie Read Scope gives the user read-only access to the Cookie Consent module."
            }
          }
        }
      }
    }
  }
}
```