client.projects.get()

import { createClient } from "@toloka-platform/sdk";

const client = createClient({
  baseUrl: "https://platform.toloka.ai",
  apiKey: process.env.TOLOKA_API_KEY!,
});

const project = await client.projects.get({
  projectId: "pp.019a0000-0000-7000-8000-000000000001"
});
console.log(project);

{
  "id": "pp.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "teamId": "<string>",
  "status": "draft",
  "createdAt": "2026-01-01T00:00:00Z"
}

import { createClient } from "@toloka-platform/sdk";

const client = createClient({
  baseUrl: "https://platform.toloka.ai",
  apiKey: process.env.TOLOKA_API_KEY!,
});

const project = await client.projects.get({
  projectId: "pp.019a0000-0000-7000-8000-000000000001"
});
console.log(project);

{
  "id": "pp.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "teamId": "<string>",
  "status": "draft",
  "createdAt": "2026-01-01T00:00:00Z"
}

Return the project name, owning team, status, and creation time. Returns 404 if the project is unavailable to you.

Signature

Method signature on client.projects:

get(args: {
  projectId: string;
}): Promise<Project>;

Parameters

string

required

Project ID with prefix pp..

Returns

Promise<Project> A project: a team-scoped container for pipelines and datasets.

ProjectId

required

Project ID with prefix pp..

string

required

Name of the project.

string

required

Identifier of the team that owns the project.

"draft" | "active"

required

Project state: draft before activation or active after activation.

string

required

Time the project was created, as an ISO 8601 timestamp.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses:

Status	Description
404	Project not found
429	Rate limit exceeded

HTTP endpoint: GET /projects/{projectId}.

import { createClient } from "@toloka-platform/sdk";

const client = createClient({
  baseUrl: "https://platform.toloka.ai",
  apiKey: process.env.TOLOKA_API_KEY!,
});

const project = await client.projects.get({
  projectId: "pp.019a0000-0000-7000-8000-000000000001"
});
console.log(project);

{
  "id": "pp.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "teamId": "<string>",
  "status": "draft",
  "createdAt": "2026-01-01T00:00:00Z"
}

Reference

TypeScript SDK

CLI

HTTP API

Signature

Parameters

Returns

Errors

​Signature

​Parameters

​Returns

​Errors

Signature

Parameters

Returns

Errors