Skip to content
FeedbackDashboard

Retrieve project

projects.retrieve(ProjectRetrieveParams**kwargs) -> Project
get/v0/projects/{project}

Retrieve a project by name.

ParametersExpand Collapse
project: Optional[str]
ReturnsExpand Collapse
class Project:

A project is a collection of SDKs generated from the same set of config files.

config_repo: str
display_name: Optional[str]
object: Literal["project"]
org: str
slug: str
targets: List[Target]
Accepts one of the following:
"node"
"typescript"
"python"
"go"
"java"
"kotlin"
"ruby"
"terraform"
"cli"
"php"
"csharp"
Retrieve project
import os
from stainless_v0 import Stainless

client = Stainless(
    api_key=os.environ.get("STAINLESS_API_KEY"),  # This is the default and can be omitted
)
project = client.projects.retrieve(
    project="project",
)
print(project.config_repo)
{
  "config_repo": "config_repo",
  "display_name": "display_name",
  "object": "project",
  "org": "org",
  "slug": "slug",
  "targets": [
    "node"
  ]
}
Returns Examples
{
  "config_repo": "config_repo",
  "display_name": "display_name",
  "object": "project",
  "org": "org",
  "slug": "slug",
  "targets": [
    "node"
  ]
}