List

List all Hire Group Campaign’s Tasks Groups.

Request

GET https://ttv.microworkers.com/api/v2/hire-group-campaigns/{campaignId}/tasks-groups

Parameters

Path Parameter    
Name Type Description
campaignId string The ID of Campaign.
Query Parameters    
Name Type Description
pageSize integer The maximum number of Tasks Groups to include in the response, used for paging. Default: 10.
sort string Results may be sorted by: id, createdAt. 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 TasksGroupListResponse OK
401   Unauthorized
403   Access denied
404   Not found

Response Body

{
  "items": [
    {
      "id": string,
      "taskIds": [
        string
      ],
      "availableSlots": integer,
      "createdAt": datetime,
      "skippedWorkerIds": [
        string
      ],
      "published": boolean
    }
  ],
  "perPage": integer,
  "nextPageToken": string
}

TasksGroupListResponse

Property Type Description
items array[TasksGroupInfoResponse] List of Tasks Groups.
nextPageToken string The pagination token of next page of results.
perPage integer The number of items per page.