> ## Documentation Index
> Fetch the complete documentation index at: https://docs.galileo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# getProject

***

# Function: getProject()

```ts theme={null}
function getProject(options: GetProjectOptions): Promise<{
  bookmark?: boolean;
  createdAt: string;
  createdBy: string;
  createdByUser: {
    email: string;
    firstName?: null | string;
    id: string;
    lastName?: null | string;
  };
  description?: null | string;
  id: string;
  labels?: "sample"[];
  name?: null | string;
  permissions?: object[];
  runs: object[];
  type?:
    | null
    | "prompt_evaluation"
    | "llm_monitor"
    | "gen_ai"
    | "training_inference"
    | "protect";
  updatedAt: string;
}>;
```

Defined in: [src/utils/projects.ts](https://github.com/rungalileo/galileo-js/blob/main/src/utils/projects.ts)

Gets a project by ID or name.

## Parameters

### options

[`GetProjectOptions`](/sdk-api/typescript/reference/types/type-aliases/GetProjectOptions)

The lookup options.

## Returns

`Promise`\<\{
`bookmark?`: `boolean`;
`createdAt`: `string`;
`createdBy`: `string`;
`createdByUser`: \{
`email`: `string`;
`firstName?`: `null` | `string`;
`id`: `string`;
`lastName?`: `null` | `string`;
};
`description?`: `null` | `string`;
`id`: `string`;
`labels?`: `"sample"`\[];
`name?`: `null` | `string`;
`permissions?`: `object`\[];
`runs`: `object`\[];
`type?`: | `null`
\| `"prompt_evaluation"`
\| `"llm_monitor"`
\| `"gen_ai"`
\| `"training_inference"`
\| `"protect"`;
`updatedAt`: `string`;
}>

A promise that resolves to the matching project.