Get a list of message threads

To get the list of message threads, send a GET request to the resource message-threads

Get api/v1/message-threads ?
  [folder=<folders to search for the thread in>]
& [folder_ne=<folders to not search for the thread>]
& [id_gt=<task suite ID>]
& [id_gte=<task suite ID>]
& [id_lt=<task suite ID>]
& [id_lte=<task suite ID>]
& [created_gt=<date>]
& [created_gte=<date>]
& [created_lt=<date>]
& [created_lte=<date>]
& [sort=<fields to sort by>]
& [limit=<maximum number of results in the response>]

Host: https://sandbox.toloka.yandex.ru
Authorization: OAuth <OAuth token>
Request parameters

Parameter

Description

Data type

folder Folders to search for the thread:
  • INBOX — Inbox.
  • OUTBOX — Sent.
  • AUTOMATIC_NOTIFICATION — Notifications.
  • IMPORTANT — Important.
  • UNREAD — Unread.
String
folder_ne Folders to not search for the thread: You can specify multiple comma-separated values. String

id_gt

Threads with an ID greater than the specified value.

String

id_gte

Threads with an ID greater than or equal to the specified value.

String

id_lt

Threads with an ID less than the specified value.

String

id_lte

Threads with an ID less than or equal to the specified value.

String

created_gt

Threads created after the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

created_gte

Threads created after or on the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

created_lt

Threads created before the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

created_lte

Threads created before or on the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

String

sort

Parameters for sorting in ascending order:

  • id — The ID of a task suite.

  • created — The date the task suite was created, in UTC in the format YYYY-MM-DD.

You can separate parameters with a comma.

To change the sorting direction to descending, add the minus sign before the parameter. For example, sort=-id.

String

limit

Limit on the number of results to return. By default — 50; maximum — 300.

Number