client.audience.specializations.listAll()

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

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

for await (const item of client.audience.specializations.listAll({})) {
  console.log(item);
}

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

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

const page = await client.audience.specializations.listPage({});
console.log(page);

{
  "id": "<string>",
  "name": "<string>",
  "expertsCount": 0
}

{
  "specializations": [
    {
      "id": "<string>",
      "name": "<string>",
      "expertsCount": 0
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}

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

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

for await (const item of client.audience.specializations.listAll({})) {
  console.log(item);
}

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

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

const page = await client.audience.specializations.listPage({});
console.log(page);

{
  "id": "<string>",
  "name": "<string>",
  "expertsCount": 0
}

{
  "specializations": [
    {
      "id": "<string>",
      "name": "<string>",
      "expertsCount": 0
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}

Return a page of expert specializations and eligible expert counts, sorted by name and ID. The default and maximum page size is 1000. Use each result’s id as qualificationId and name as value in audience.specializations.values[]. The listAll* variant yields items across every page. The other variant returns one page with pagination metadata. See Pagination.

Signature

Method signatures on client.audience.specializations:

listAll(args?: {
  limit?: number;
  offset?: number;
}): AsyncGenerator<Specialization>;

listPage(args?: {
  limit?: number;
  offset?: number;
}): Promise<{ specializations: Specialization[]; pagination: Pagination }>;

Parameters

listAll()

The argument object can be omitted.

number

default:"1000"

Maximum number of results to return, from 1 to 1000; defaults to 1000.

number

default:"0"

Number of results to skip before this page; defaults to 0.

listPage()

The argument object can be omitted.

number

default:"1000"

Maximum number of results to return, from 1 to 1000; defaults to 1000.

number

default:"0"

Number of results to skip before this page; defaults to 0.

Returns

listAll() result

AsyncGenerator<Specialization> Yields one item at a time. The fields below describe each yielded item. An expert specialization (platform qualification) that a node audience can require.

string

required

The platform qualification id. Use it as qualificationId in a node audience filter (audience.specializations.values[]).

string

required

The human-readable specialization name. Use it as value next to the qualificationId.

number

required

How many ID-verified experts currently eligible for tasks hold this specialization.

listPage() result

Promise<{ specializations: Specialization[]; pagination: Pagination }>

Specialization[]

required

Expert specializations and eligible expert counts in this page.

Show Fields

string

required

The platform qualification id. Use it as qualificationId in a node audience filter (audience.specializations.values[]).

string

required

The human-readable specialization name. Use it as value next to the qualificationId.

number

required

How many ID-verified experts currently eligible for tasks hold this specialization.

Pagination

required

Pagination information for this page.

Show Fields

number

required

Total number of matching results.

number

required

Maximum number of results requested for this page.

number

required

Number of results skipped before this page.

boolean

required

Whether more matching results follow this page.

Errors

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

Status	Description
400	`limit` is not an integer between 1 and 1000, or `offset` is not a non-negative integer
429	Rate limit exceeded

HTTP endpoint: GET /audience/specializations.

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

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

for await (const item of client.audience.specializations.listAll({})) {
  console.log(item);
}

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

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

const page = await client.audience.specializations.listPage({});
console.log(page);

{
  "id": "<string>",
  "name": "<string>",
  "expertsCount": 0
}

{
  "specializations": [
    {
      "id": "<string>",
      "name": "<string>",
      "expertsCount": 0
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}

Reference

TypeScript SDK

CLI

HTTP API

client.audience.specializations.listAll()

Signature

Parameters

listAll()

listPage()

Returns

listAll() result

listPage() result

Errors