Class Project

Index

Constructors

Methods

Constructors

constructor

new Project(client: Client): Project
Parameters
- client: Client
Returns Project
- Defined in packages/client/src/resources/project.ts:7

Methods

get

get(): Promise<
    {
        createdAt: string;
        id: string;
        name: string;
        organizationId: string;
        slug: string;
        updatedAt: string;
    },
>
Get current project

Returns the project associated with the API key used for authentication.

The project contains metadata about your organization's configuration, including:
- Project ID and organization ID
- Project name and slug
- Creation and update timestamps
This endpoint is useful for verifying your API key is valid and retrieving project details.
Returns Promise<
    {
        createdAt: string;
        id: string;
        name: string;
        organizationId: string;
        slug: string;
        updatedAt: string;
    },
>
Project found
Example
```
const result = await client.project.get();
console.log(result);
```
Throws
Unauthorized - Invalid or missing API key

Throws
Project not found

Throws
If a network error occurs
- Defined in packages/client/src/resources/project.ts:33