Amazon Mechanical Turk
API Reference (API Version 2017-01-17)

ListWorkerBlocks

Description

The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs.

Request Syntax

{ "NextToken": String, "MaxResults": Integer }

Request Parameters

The request accepts the following data in JSON format:

Name Description Required

NextToken

Pagination token

Type: String

No

MaxResults

Type: Integer

No

Response Elements

A successful request returns a paginated list of Workers that have been blocked along with the reason for the block.

Example

The following example shows how to use the ListWorkerBlocks operation:

Sample Request

The following example lists all Worker blocks.

POST / HTTP/1.1 Host: mturk-requester.us-east-1.amazonaws.com Content-Length: <PayloadSizeBytes> X-Amz-Date: <Date> { }

Sample Response

The following is an example response:

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { WorkerBlocks:[{WorkerId, Reason}], NumResults:3 }