ZITADEL Docs
APIsCore ResourcesV2Project

Get Project

Returns the project identified by the requested ID.

Required permission:

  • project.read
POST
/zitadel.project.v2.ProjectService/GetProject

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

projectId*string

ProjectID is the unique identifier of the project to be retrieved.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/zitadel.project.v2.ProjectService/GetProject" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "projectId": "string"  }'
{
  "project": {
    "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": {}
    }
  ]
}

Was this page helpful?

Delete Project Grant

Delete Project Grant: Delete a project grant. All user grants (role assignments) for this project grant will also be removed. A user will not have access to the project afterward (if permissions are checked). In case th...

List Project Grants

List Project Grants: Returns a list of project grants. A project grant is when the organization grants its project to another organization. Required permission: