client.expertBanList.get()

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

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

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

{
  "projectId": "pp.019a0000-0000-7000-8000-000000000001",
  "expertCount": 0,
  "stats": {
    "pending": 0,
    "banned": 0,
    "notFound": 0,
    "unbanning": 0
  }
}

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

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

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

{
  "projectId": "pp.019a0000-0000-7000-8000-000000000001",
  "expertCount": 0,
  "stats": {
    "pending": 0,
    "banned": 0,
    "notFound": 0,
    "unbanning": 0
  }
}

Return how many experts are in the project’s own ban list and how many are in each status. Banned experts cannot work on the project. Team-wide bans also apply but are managed in the platform UI and not counted here. Available only to teams with expert bans enabled.

Signature

Method signature on client.expertBanList:

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

Parameters

string

required

Project ID with prefix pp..

Returns

Promise<ExpertBanListDetails> The expert ban list of a project: experts who cannot work on it.

ProjectId

required

Project ID with prefix pp..

number

required

Number of experts in the ban list.

object

required

How many experts of the ban list are in each status.

Show Fields

number

required

Bans still being applied.

number

required

Bans in force.

number

required

IDs that match no expert.

number

required

Bans being lifted.

Errors

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

Status	Description
404	Project or expert list not found, or not available for it
429	Rate limit exceeded

HTTP endpoint: GET /projects/{projectId}/expert-ban-list.

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

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

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

{
  "projectId": "pp.019a0000-0000-7000-8000-000000000001",
  "expertCount": 0,
  "stats": {
    "pending": 0,
    "banned": 0,
    "notFound": 0,
    "unbanning": 0
  }
}

Reference

TypeScript SDK

CLI

HTTP API

Signature

Parameters

Returns

Errors

​Signature

​Parameters

​Returns

​Errors

Signature

Parameters

Returns

Errors