Get

Gets information about Worker.

Request

GET https://ttv.microworkers.com/api/v2/workers/{workerId}

Parameters

Path Parameter

Name

Type

Description

workerId

string

The ID of Worker.

Response

Response HTTP Codes

Http Code

Response Type

Description

200

WorkerProfileResponse

OK

401

Unauthorized

404

Not found

Response Body

{
  "id": string,
  "username": string,
  "registeredAt": datetime,
  "location": {
    "city": string,
    "country": {
      "id": string,
      "name": string
    }
  },
  "mwStats": {
    "totalEarned": integer,
    "tasksCompleted": integer,
    "basicTasksSatisfied": integer,
    "basicTasksNotSatisfied": integer,
    "hireGroupTasksSatisfied": integer,
    "hireGroupTasksNotSatisfied": integer,
    "admissionTest": string
  },
  "badges": [
    {
      "id": string,
      "starAssessment": float or null,
      "tasksCompleted": integer,
      "tasksSatisfied": integer,
      "tasksNotSatisfied": integer,
      "title": string
    }
  ]
}

WorkerProfileResponse

Property

Type

Description

id

string

The ID of Worker.

username

string

The username of Worker.

registeredAt

datetime

Worker’s registration date.

location

LocationResponse

Worker’s location.

mwStats

MwStatsResponse

Statistics.

badges

array[BadgeResponse]

Badges.

LocationResponse

Property

Type

Description

city

string

City.

country

CountryResponse

Country.

CountryResponse

Property

Type

Description

id

string

Country code.

name

string

Country name.

MwStatsResponse

Property

Type

Description

totalEarned

float

Total amount of money worker earned.

tasksCompleted

integer

Number of tasks completed by worker.

basicTasksSatisfied

integer

Number of basic campaign tasks marked by Employers as Satisfied.

basicTasksNotSatisfied

integer

Number of basic campaign tasks marked by Employers as Not Satisfied.

hireGroupTasksSatisfied

integer

Number of hire group campaign tasks marked by Employers as Satisfied.

hireGroupTasksNotSatisfied

integer

Number of hire group campaign tasks marked by Employers as Not Satisfied.

admissionTest

string

Microworkers Qualification/Admission test [1] pass result: N/A, Pass, Fail.

BadgeResponse

Property

Type

Description

id

string

The ID of Badge.

starAssessment

float|null

Star assessment.

tasksCompleted

integer

Number of tasks completed by worker.

tasksSatisfied

integer

Number of tasks marked by Employers as Satisfied.

tasksNotSatisfied

integer

Number of tasks marked by Employers as Satisfied.

title

string

The title of Badge.