List Projects

List all matching projects. By default all projects of the instance that the caller has permission to read are returned. Make sure to include a limit and sorting for pagination.

Required permission:

project.read

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1

Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

pagination?|

Pagination can be used to list limitations and ordering.

sortingColumn?|

SortingColumn is the field the result is sorted by. The default is the creation date. Beware that if you change this, your result pagination might be inconsistent.

filters?array<||>

Filters define the criteria to query for.

Response Body

`application/json`

curl -X POST "https://loading/zitadel.project.v2.ProjectService/ListProjects" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'

{
  "pagination": {
    "totalResult": 0,
    "appliedLimit": 0
  },
  "projects": [
    {
      "projectId": "string",
      "organizationId": "string",
      "creationDate": "2023-01-15T01:30:15.01Z",
      "changeDate": "2023-01-15T01:30:15.01Z",
      "name": "string",
      "state": "PROJECT_STATE_UNSPECIFIED",
      "projectRoleAssertion": true,
      "authorizationRequired": true,
      "projectAccessRequired": true,
      "privateLabelingSetting": "PRIVATE_LABELING_SETTING_UNSPECIFIED",
      "grantedOrganizationId": "string",
      "grantedOrganizationName": "string",
      "grantedState": "GRANTED_PROJECT_STATE_UNSPECIFIED"
    }
  ]
}

{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Header Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`