Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/zitadel/zitadel/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

POST /v2/applications/_search

​
Description

Returns a list of applications matching the input parameters. The results can be filtered by project, state, type, and name. It can be sorted by id, name, creation date, change date, or state.

​
Required Permission

  • project.app.read

​
Request Body

​
pagination
object
Pagination and sorting.
​
offset
string
Pagination offset.
​
limit
integer
Maximum number of results.
​
asc
boolean
Sort ascending.
​
sortingColumn
string
Field to sort by.Options:
  • APPLICATION_SORTING_APP_NAME
  • APPLICATION_SORTING_CREATION_DATE
  • APPLICATION_SORTING_CHANGE_DATE
​
filters
array
Criteria to filter the applications.
​
nameFilter
object
Filter by application name.
​
name
string
Name to search for.
​
method
string
Search method.
​
projectIdFilter
object
Filter by project.
​
projectId
string
Project ID to filter by.
​
appStateFilter
object
Filter by application state.
​
state
string
State to filter by.

​
Response

​
applications
array
List of applications matching the query.
​
applicationId
string
Unique identifier of the application.
​
projectId
string
Project ID the application belongs to.
​
name
string
Name of the application.
​
state
string
Current state of the application.
​
oidcConfig
object
OIDC configuration (if applicable).
​
clientId
string
OAuth2 client ID.
​
redirectUris
array
Configured redirect URIs.
​
apiConfig
object
API configuration (if applicable).
​
samlConfig
object
SAML configuration (if applicable).
​
pagination
object
Pagination information.
​
totalResult
string
Total number of apps matching the query.

​
Example Request

curl -X POST https://your-domain.zitadel.cloud/v2/applications/_search \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "pagination": {
      "limit": 50,
      "asc": true
    },
    "sortingColumn": "APPLICATION_SORTING_APP_NAME",
    "filters": [
      {
        "projectIdFilter": {
          "projectId": "69629026806489455"
        }
      }
    ]
  }'

​
Example Response

{
  "applications": [
    {
      "applicationId": "1035496534033449",
      "projectId": "69629026806489455",
      "name": "My Web App",
      "state": "APP_STATE_ACTIVE",
      "oidcConfig": {
        "clientId": "1035496534033449@myproject",
        "redirectUris": ["https://myapp.com/callback"]
      }
    }
  ],
  "pagination": {
    "totalResult": "8"
  }
}

​
Error Responses

  • 400 Bad Request - Invalid query parameters
  • 403 Forbidden - Insufficient permissions

Build docs developers (and LLMs) love

Get started for freeTalk to us