Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zitadel Projects API

Manage projects and project grants

Zitadel Projects API is one of 11 APIs that Zitadel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 13 JSON Schema definitions.

Tagged areas include Projects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and 13 JSON Schemas.

This API exposes 5 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://{instance}.zitadel.cloud, https://{custom-domain}.

5 operations 3 paths 6 schemas 1 DELETE1 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
https://{instance}.zitadel.cloud
https://{custom-domain}
Authentication
HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Zitadel Projects API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Projects 5

Manage projects and project grants

POST
/management/v1/projects
Zitadel Create Project
createProject body → 200
POST
/management/v1/projects/_search
Zitadel List Projects
listProjects → 200
GET
/management/v1/projects/{projectId}
Zitadel Get Project by ID
getProjectById 1 param → 200
PUT
/management/v1/projects/{projectId}
Zitadel Update Project
updateProject 1 param body → 200
DELETE
/management/v1/projects/{projectId}
Zitadel Remove Project
removeProject 1 param → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Project (8 properties), ObjectDetails (4 properties), CreateProjectRequest (4 properties), ListDetails (3 properties). Each schema is shown below with its type and property counts.

CreateProjectRequest
object
4 properties 1 required
ListDetails
object
3 properties
ProjectResponse
object
1 property
ListProjectsResponse
object
2 properties
Project
object
8 properties
ObjectDetails
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zitadel-projects-api-openapi.yml Raw ↑

Other APIs Zitadel publishes across the network.

Zitadel Auth API
Zitadel Admin API
Zitadel OIDC / OAuth 2.0
Zitadel SAML API
Zitadel Applications API
Zitadel Identity Providers API
Zitadel Organizations API
Zitadel Policies API
Zitadel Roles API
Zitadel Users API