List

List all Hire Group Campaigns.

Request

GET https://ttv.microworkers.com/api/v2/hire-group-campaigns

Parameters

Query Parameters
Name	Type	Description
pageSize	integer	The maximum number of Campaigns to include in the response, used for paging. Default: 10.
sort	string	Results may be sorted by: id, title, created. Default: -created.
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.
filter[folder]	string	Filter campaigns by folder. Allowed values: DEFAULT, ARCHIVE.
filter[created][op]	string	Filter Campaigns by creation date operator. Required, if filter[created][value] provided. Allowed values: gt, gte, lt, lte, between. gt - Greater than. gte - Greater than or equal. lt - Less than. lte - Less than or equal. between - In range.
filter[created][value]	string	Filter Campaigns by creation date value. Required, if filter[created][op] provided. Value should be in format yyyy-mm-ddThh:mm:ss+00:00 if filter[created][op] is one of gt, gte, lt, lte. Value should be in format yyyy-mm-ddThh:mm:ss+00:00..yyyy-mm-ddThh:mm:ss+00:00 if filter[created][op] is between.

Response

Response HTTP Codes

Http Code	Response Type	Description
200	HireGroupCampaignListResponse	OK
401		Unauthorized

Response Body

{
  "items": [
    {
      "maxPositionPerWorker": integer,
      "groupId": string,
      "categoryId": string,
      "id": string,
      "autoSkipTask": {
        "enabled": boolean,
        "timeLimit": integer
      },
      "title": string,
      "description": string,
      "folder": string,
      "ttr": integer,
      "availablePositions": integer,
      "blockedReason": string,
      "status": string,
      "created": datetime,
      "blocked": datetime,
      "approved": datetime,
      "finished": datetime,
      "htmlCode": string,
      "minutesToFinish": integer,
      "paymentPerTask": float,
      "variables": [
        string
      ],
      "questions": [
        {
          "id": string,
          "name": string,
          "required": boolean,
          "tag": string
        }
      ],
      "jobQueues": {
        "csvUploadJob": {
          "id": string,
          "status": string,
          "output": string
        },
        "restartCampaignJob": {
          "id": string,
          "status": string,
          "output": string
        },
        "addPositionJob": {
          "id": string,
          "status": string,
          "output": string
        }
      },
      "qtRequired": boolean,
      "internalTemplate": {
        "adminInstructions": string,
        "numberOfSubTasks": integer,
        "displaySubTasksOnSamePage": boolean,
        "ratingMethodId": integer,
        "id": string,
        "numberOfFileProofs": integer,
        "allowedFileTypes": [
          string
        ]
      },
      "externalTemplate": {
        "url": string,
        "height": string,
        "width": string,
        "parameters": [
          string
        ]
      },
      "maximumJobLimit": {
        "enabled": boolean,
        "limitPerDay": integer,
        "advancedSchedule": {
          "timeZone": string,
          "limitPerHour": integer,
          "events": [
            {
              "type": string,
              "daysOfWeek": [
                integer
              ],
              "startTime": string,
              "endTime": string,
              "startRecur": datetime,
              "endRecur": datetime,
              "limitPerDay": integer,
              "limitPerHour": integer
            },
            {
              "type": string,
              "start": datetime,
              "end": datetime,
              "allDay": boolean,
              "limitPerDay": integer,
              "limitPerHour": integer
            }
          ]
        },
        "standardSchedule": {
          "timeZone": string,
          "limitPerHour": integer,
          "allDay": boolean,
          "allWeekdays": boolean,
          "daysOfWeek": [
            integer
          ],
          "workingHours": [
            string
          ]
        }
      },
      "slotsCount": {
        "locked": integer,
        "unTaken": integer,
        "ok": integer,
        "nok": integer,
        "notRated": integer,
        "notReviewed": integer,
        "revise": integer,
        "reviseAdmin": integer
      },
      "notificationSettings": [
        {
          "url": string,
          "type": string,
          "notificationTypes": [
            string
          ]
        }
      ],
      "visibilityDelay": integer,
      "estimateCost": float,
      "jsSection":  string,
      "cssSection": string
    }
  ],
  "nextPageToken": string,
  "perPage": integer
}

HireGroupCampaignListResponse

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