Supported Formats

json

GET /api/me
Returns the details of current user.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Examples

GET /api/me
200

GET /api/users
Lists users.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
q
optional

Keyword to be searched

Validations:

  • Must be a String


GET /api/users/:id
Shows the given user details.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User Not Found.

Params

Param name Description
id
required

User ID

Validations:

  • Must be a String


PUT /api/users/:id
Updates current user.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User Not Found.
422 Unprocessable User.

Examples

PUT /api/users/59c241d7a83dc1219d4f299b
{
  "user": {}
}
401

Params

Param name Description
id
required

User ID

Validations:

  • Must be a String

user
required

User parameter container

Validations:

  • Must be an Array of nested elements

user[first_name]
optional

Validations:

  • Must be a String

user[middle_name]
optional

Validations:

  • Must be a String

user[last_name]
optional

Validations:

  • Must be a String

user[languages]
optional

Validations:

  • Must be an array of any type

user[gender]
optional

Validations:

  • Must be a String

user[categories]
optional

Validations:

  • Must be a String

user[education_level]
optional

Validations:

  • Must be a String

user[freelancer_type]
optional

Validations:

  • Must be a String

user[birth_date]
optional

Validations:

  • Must be a String

user[customer]
optional

Validations:

  • Must be a Boolean


PATCH /api/users/:id/update_password
Updates user password

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User not found
422 Unprocessable User

Examples

PATCH /api/users/59c241d6a83dc1219d4f2989/update_password
{
  "user": {}
}
401

Params

Param name Description
id
required

User ID

Validations:

  • Must be a String

user
required

User parameter container

Validations:

  • Must be an Array of nested elements

user[current_password]
required

User’s current password.

Validations:

  • Must be a String

user[password]
required

User’s new password

Validations:

  • Must be a String

user[password_confirmation]
required

The confirmation of new password

Validations:

  • Must be a String


PATCH /api/users/:id/accept_tnc
Accepts Terms & Conditions

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User not found
422 Unprocessable User

Params

Param name Description
id
required

User Id

Validations:

  • Must be a String


PATCH /api/users/:id/update_email
Updates user e-mail. This requires current password of user.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User not found
422 Unprocessable User

Examples

PATCH /api/users/59c241d5a83dc1219d4f294a/update_email
{
  "user": {}
}
401

Params

Param name Description
id
required

User ID

Validations:

  • Must be a String

user
required

User parameter container

Validations:

  • Must be an Array of nested elements

user[email]
required

E-mail to be changed

Validations:

  • Must be a String

user[current_password]
optional

User’s current password

Validations:

  • Must be a String


POST /api/users/:id/send_confirmation_instructions
Send confirmation instructions

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User Not Found

Examples

POST /api/users/59c241d6a83dc1219d4f297d/send_confirmation_instructions
{
  "user": {}
}
401

Params

Param name Description
id
required

User ID

Validations:

  • Must be a String


POST /api/users/check_email
Checks whether an e-mail exists or not

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
422 Unprocessable User

Examples

POST /api/users/check_email
{
  "email": "test@test.com"
}
204

Params

Param name Description
email
required

Email to be searched

Validations:

  • Must be a String


POST /api/users/check_username
Checks whether a username exists or not

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
422 Unprocessable User

Params

Param name Description
username
required

Username to be searched

Validations:

  • Must be a String


GET /api/users/approved_balances
Download approved balances in given format

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

POST /api/users/upload_approved_balances
Bulk upload for approved balances in Euro.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Examples

POST /api/users/upload_approved_balances
{
  "file": "<FILE CONTENT 'approved_balances.tsv'>"
}
403

POST /api/users/confirm_account
Confirms user account with confirmation token

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
422 Invalid confirmation token

Examples

POST /api/users/confirm_account
{
  "confirmation_token": null,
  "user": {
    "confirmation_token": null
  }
}
204

Params

Param name Description
confirmation_token
required

Confirmation Token

Validations:

  • Must be a String


GET /api/users/:id/authorized_applications
List current users's authorized applications.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User Not Found.

Params

Param name Description
id
required

User ID

Validations:

  • Must be a String


DELETE /api/users/:id/authorized_applications
Revoke current users's authorized application.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User Not Found.
404 Application Not Found

Params

Param name Description
id
required

User ID

Validations:

  • Must be a String

application_id
required

Application ID

Validations:

  • Must be a String


GET /api/users/:id/scores
Shows the given user's scores.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User Not Found.

Examples

GET /api/users/59c24193a83dc1219d4eeafe/scores
200

Params

Param name Description
id
required

User ID

Validations:

  • Must be a String


GET /api/users/:id/quality_score_graph
Returns quality score time series to draw graph.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User Not Found.

Params

Param name Description
id
required

User Id

Validations:

  • Must be a String


GET /api/users/:id/quality_score_details
Returns quality score time series to draw graph.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User Not Found.

Params

Param name Description
id
required

User Id

Validations:

  • Must be a String

language
required

Date in the format of YYYY-MM-DD

Validations:

  • Must be a String

score_date
required

Date in the format of YYYY-MM-DD

Validations:

  • Must be a String


GET /api/users/:id/statistics
Shows the given user statistics.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 User Not Found.

Params

Param name Description
id
required

User ID

Validations:

  • Must be a String

daily_activity_counts
optional

daily_activity_counts=all if statistics needed

Validations:

  • Must be a String

daily_activity_seconds
optional

daily_activity_seconds=all if statistics needed

Validations:

  • Must be a String

daily_hourly_rates
optional

daily_hourly_rates=all if statistics needed

Validations:

  • Must be a String

activities
optional

activities=all if statistics needed

Validations:

  • Must be a String

levels
optional

levels=all if statistics needed

Validations:

  • Must be a String


GET /api/users/user_signup_statistics
Returns new user count though given date range

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
first_date
required

First date

Validations:

  • Must be a String

last_date
required

Second date

Validations:

  • Must be a String


GET /api/users/daily_active_users
Returns daily active users in give range

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
first_date
required

First date

Validations:

  • Must be a String

last_date
required

Last date

Validations:

  • Must be a String


GET /api/users/free_sample_statistics
Get free sample statistics

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
first_date
required

First date of query

Validations:

  • Must be a DateTime

last_date
required

Last date of query

Validations:

  • Must be a DateTime

type
required

Storage type

Validations:

  • Must be a String


GET /api/users/language_levels_statistics
Get lang level stat on daily basis

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
first_date
required

First date of query

Validations:

  • Must be a DateTime

last_date
required

Last date of query

Validations:

  • Must be a DateTime

language
required

Ask a language to retrieve results

Validations:

  • Must be a String