List

List all Hire Group Workers.

Request

GET https://ttv.microworkers.com/api/v2/hire-groups/custom/{id}/workers

Parameters

Path Parameter
Name	Type	Description
id	string	The ID of Hire Group.

Query Parameters
Name	Type	Description
pageSize	integer	The maximum number of workers to include in the response, used for paging. Default: `10`.
sort	string	Results may be sorted by: `countryIsoCode`, `city`. Default: `countryIsoCode,city`.
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	GroupWorkerListResponse	OK
401		Unauthorized

Response Body

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

GroupWorkerListResponse

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

GroupWorkerInfoResponse

Property	Type	Description
id	string	The ID of Worker.
username	string	Username.
countryIsoCode	string	Country ISO code.
country	string	Country name.
city	string	City.