Skip to content
  • Auto
  • Light
  • Dark

Retrieve

Retrieve a project by name
client.projects.retrieve(ProjectRetrieveParamsparams?, RequestOptionsoptions?): config_repostringdisplay_nameunionobject"project"orgstringslugstringtargetsarrayProject
get/v0/projects/{project}

Retrieve a project by name

Parameters
paramsprojectstringProjectRetrieveParams
Hide ParametersShow Parameters
projectstring
optional
Returns
config_repostringdisplay_nameunionobject"project"orgstringslugstringtargetsarrayProject
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);
200 Example
{
  "config_repo": "config_repo",
  "display_name": "display_name",
  "object": "project",
  "org": "org",
  "slug": "slug",
  "targets": [
    "node"
  ]
}