Retrieve project

client.projects.retrieve(?, ?): Project { config_repo, display_name, object, 3 more }

get/v0/projects/{project}

Retrieve a project by name.

ParametersExpand Collapse

params: ProjectRetrieveParams { project }

project?: string

ReturnsExpand Collapse

Project { config_repo, display_name, object, 3 more }

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

config_repo: string

display_name: string | null

object: "project"

Accepts one of the following:

"project"

org: string

slug: string

targets: Array<Target>

Accepts one of the following:

"node"

"typescript"

"python"

"go"

"java"

"kotlin"

"ruby"

"terraform"

"cli"

"php"

"csharp"

Retrieve project

IMPORT STAINLESS FROM '@STAINLESS-API/SDK';

CONST CLIENT = NEW STAINLESS({
  APIKEY: 'MY API KEY',
});

CONST PROJECT = AWAIT CLIENT.PROJECTS.RETRIEVE({ PROJECT: 'PROJECT' });

CONSOLE.LOG(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"
  ]
}