Get a project

OpenAPI contract

Method

GET

Path

/api/v1/projects/{id}

Security

jwtBearer (bearer) OR automationKey (bearer)

Response status

200 400 401 403 404 409 429 500

Request and response schemas

JSON

{
  "requestBody": {},
  "responses": {
    "200": {
      "description": "Project",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ProjectResponse"
        }
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Authentication required or invalid",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "403": {
      "description": "Authenticated but not permitted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "404": {
      "description": "Requested project or build was not found",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "409": {
      "description": "Request conflicts with current project state",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "429": {
      "description": "HTTP rate limit or API-key NCU usage limit exceeded",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RateLimitError"
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

GET /api/v1/projects/{id} accepts a JWT or an nfy_ key with project:read. The caller must resolve the collaboration capability project:read through workspace membership or a direct project grant. The response includes workspace and organization IDs, access mode, effective project role and capabilities, saved defaults, and build summary fields. A project outside the caller's visible boundary is reported as not found.

http

GET /api/v1/projects/{id}
Authorization: Bearer <access token>