List

List all Excluded Workers.

Request

GET https://ttv.microworkers.com/api/v2/account/excluded-workers

Parameters

Query Parameters    
Name Type Description
pageSize integer The maximum number of excluded workers to include in the response, used for paging. Default: 10.
sort string Results may be sorted by: id, username, countryCode. Default: id.
nextPageToken string The pagination token used to get the next page of results, set this parameter to the value of “nextPageToken” from the previous response.

Response

Response HTTP Codes

Http Code Response Type Description
200 ExcludedWorkerListResponse OK
401   Unauthorized

Response Body

{
  "items": [
    {
      "id": string,
      "country": string,
      "countryCode": string,
      "username": string
    }
  ],
  "perPage": integer,
  "nextPageToken": string
}

ExcludedWorkerListResponse

Property Type Description
items array[ExcludedWorkerResponse] List of excluded Workers.
nextPageToken string The pagination token of next page of results.
perPage integer The number of items per page.

ExcludedWorkerResponse

Property Type Description
id string The ID of Worker.
country string Country Name.
countryCode string Country ISO Code.
username string The Username of Worker.