List

List all custom Hire Groups.

Request

GET https://ttv.microworkers.com/api/v2/hire-groups/custom

Parameters

Query Parameters

Name

Type

Description

pageSize

integer

The maximum number of Hire Groups to include in the response, used for paging. Default: 10.

sort

string

Results may be sorted by: title. Default: title.

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

GroupListResponse

OK

401

Unauthorized

Response Body

{
  "items": [
    {
      "id": string,
      "title": string,
      "countWorkers": integer
    }
  ],
  "perPage": integer,
  "nextPageToken": string
}

GroupListResponse

Property

Type

Description

items

array[GroupInfoResponse]

List of Hire Groups.

nextPageToken

string

The pagination token of next page of results.

perPage

integer

The number of items per page.

GroupInfoResponse

Property

Type

Description

id

string

The ID of Hire Group.

title

string

The title of Hire Group.

countWorkers

integer

Number of workers in Hire Group.