reference

Users

10 endpoints

GET/api/v3/user

List Users

Requires: USER_list

query parameters

name string
wordRateInit number (double)
wordRateEnd number (double)
hourlyRateInit number (double)
hourlyRateEnd number (double)
nameOrEmail string
exactMatch boolean
country string
email string
roles string[]
status string[]
tags string[]
sourceLanguage string
targetLanguages string[]
lastAccessOlderThanDays string
neverAccessed boolean
loggedUserIsAccountAdmin boolean
taskSysAdminView boolean
strictAccountScope boolean
accountRoles string[]
accountUUID string (uuid)
isAutopilotEligibleTasksByAccountEnabled boolean
organizationUuid string (uuid)
orgUnitUuid string (uuid)
permissionGroupUuid string (uuid)
isolatedTags boolean
tagFilterDisabled boolean
useTagDictionary boolean
qualityFilterDisabled boolean
qualityGraceEnabled boolean
taskMinimumScore number
customFields map<string, object>[]
customFieldsJson string
workflow string
workflowUuid string (uuid)
sort string
page integer
Page to return, starting at 0.
size integer
Items per page.

Responses

200 OK

PageUserDto

content UserDto[]
empty boolean
first boolean
last boolean
number integer
numberOfElements integer
pageable PageableObject
size integer
sort SortObject
totalElements integer (int64)
totalPages integer

Request

curl -X GET 'https://app.wxrks.com/api/v3/user' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "content": [
    {}
  ],
  "empty": false,
  "first": false,
  "last": false,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": false,
    "sort": {},
    "unpaged": false
  },
  "size": 0,
  "sort": {
    "empty": false,
    "sorted": false,
    "unsorted": false
  },
  "totalElements": 0,
  "totalPages": 0
}

POST/api/v3/user

Create User

Requires: USER_save

Creates a user in your account, in the organizations (at least one) and orgUnits sent. Sending the uuid of an existing user updates that user instead; organizations, org units and language pairs are then left as they are.

Request body

CreateUserRequest

address string
address2 string
avatar string
cellPhone string
city string
companyName string
country string
currency string
dailyRate number
defaultWorkflowRates map<string, object>[]
emailrequired string
entryPoint stringWORKS_HOME PORTAL_HOME
externalId string
hourlyRate number
invoicingDayOfMonth stringDAY_15 DAY_30
invoicingPeriodicity integer
minimumFee number
namerequired string
notes string
notifyUser boolean
Email the new user their access. Defaults to true.
orgUnits UserAssociationRef[]
organizationsrequired UserAssociationRef[]
pagesRate number
paymentMethod stringPAYONEER PAYPAL BANK QUICKBOOKS
payoneerId string
paypalAccount string
phone string
postalCode string
roles string[]
Roles to grant. You can only grant roles you are allowed to manage; USER is always granted.
skypeId string
slackHandle string
state string
status stringActive Inactive Disabled
The user's status. Read ignoring case. New users default to Active.
supportedLanguagePairs UserLanguagePairRef[]
tags string[]
targetAccountUuid string (uuid)
wxrks staff only: the account to create the user in. Ignored for anyone else.
taxId string
taxpayerId string
timezone string
uuid string (uuid)
Leave it out to create a user. The uuid of an existing user updates that user.
wordRate number

Responses

200 OK

UserDto

accessKey string
accessKeyTimestamp integer (int64)
accountOwner boolean
accountType stringCLI PERSONAL BUSINESS ENTERPRISE OTHER
accountUuid string (uuid)
address string
address2 string
admin boolean
assignedJobs integer (int64)
avatar string
captcha string
cellPhone string
city string
companyName string
completedJobs integer (int64)
country string
currency string
customFields map<string, object>[]
dailyRate number
defaultWorkflowRates map<string, object>[]
deleteAllLanguagePair boolean
email string
emailMagicCode string
entryPoint stringWORKS_HOME PORTAL_HOME
externalId string
forwardUrl string
hourlyRate number
id integer (int64)
invoicingDayOfMonth stringDAY_15 DAY_30
invoicingPeriodicity integer
lastAccessAt integer (int64)
messageError string
messageWarning string
mfa integer (int64)
mfaEnabled boolean
minimumFee number
name string
nameEmail string
newPassword string
notes string
notifyUser boolean
orgUnits OrganizationalUnitDto[]
organizations OrganizationDto[]
pagesRate number
parentUserUuid string (uuid)
paymentMethod stringPAYONEER PAYPAL BANK QUICKBOOKS
payoneerId string
paypalAccount string
permissionGroups PermissionGroupDto[]
phone string
postalCode string
productName string
punctuality number (double)
quickBooksVendorId string
roles string[]
skypeId string
slackHandle string
state string
status stringActive Inactive Disabled
The user's status. Read ignoring case.
subUser boolean
subscriptions UserSubscriptionDto[]
supportedLanguagePairs LanguagePair[]
tags string[]
targetAccountUuid string (uuid)
tasksCompletedCount integer (int64)
taxId string
taxpayerId string
timezone string
totalJobs integer (int64)
useProjectCurrency boolean
userQualityMetrics UserQualityMetricsDto
userRates UserRateDetailsDto[]
uuid string (uuid)
wordRate number

Request

curl -X POST 'https://app.wxrks.com/api/v3/user' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Jane Doe",
  "email": "jane.doe@example.com",
  "notes": "Reviewer for the marketing org unit.",
  "roles": [
    "USER"
  ],
  "notifyUser": false,
  "organizations": [
    {
      "uuid": "0e5a8c3f-6b9d-4f72-8a1e-4c7b2d9f6a05"
    }
  ],
  "orgUnits": [
    {
      "uuid": "6b1f0c2e-8d4a-4f3b-9c5e-2a7d9e1b4c60"
    }
  ]
}'

Response 200

{
  "accessKey": "string",
  "accessKeyTimestamp": 0,
  "accountOwner": false,
  "accountType": "CLI",
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "address": "string",
  "address2": "string",
  "admin": false,
  "assignedJobs": 0,
  "avatar": "string",
  "captcha": "string",
  "cellPhone": "string",
  "city": "string",
  "companyName": "string",
  "completedJobs": 0,
  "country": "string",
  "currency": "string",
  "customFields": [
    {}
  ],
  "dailyRate": 0,
  "defaultWorkflowRates": [
    {}
  ],
  "deleteAllLanguagePair": false,
  "email": "string",
  "emailMagicCode": "string",
  "entryPoint": "WORKS_HOME",
  "externalId": "string",
  "forwardUrl": "string",
  "hourlyRate": 0,
  "id": 0,
  "invoicingDayOfMonth": "DAY_15",
  "invoicingPeriodicity": 0,
  "lastAccessAt": 0,
  "messageError": "string",
  "messageWarning": "string",
  "mfa": 0,
  "mfaEnabled": false,
  "minimumFee": 0,
  "name": "string",
  "nameEmail": "string",
  "newPassword": "string",
  "notes": "string",
  "notifyUser": false,
  "orgUnits": [
    {}
  ],
  "organizations": [
    {}
  ],
  "pagesRate": 0,
  "parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "paymentMethod": "PAYONEER",
  "payoneerId": "string",
  "paypalAccount": "string",
  "permissionGroups": [
    {}
  ],
  "phone": "string",
  "postalCode": "string",
  "productName": "string",
  "punctuality": 0,
  "quickBooksVendorId": "string",
  "roles": [
    "USER"
  ],
  "skypeId": "string",
  "slackHandle": "string",
  "state": "string",
  "status": "Active",
  "subUser": false,
  "subscriptions": [
    {}
  ],
  "supportedLanguagePairs": [
    {}
  ],
  "tags": [
    "string"
  ],
  "targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tasksCompletedCount": 0,
  "taxId": "string",
  "taxpayerId": "string",
  "timezone": "string",
  "totalJobs": 0,
  "useProjectCurrency": false,
  "userQualityMetrics": {
    "avgQualityIndex": 0,
    "id": 0,
    "maxQualityIndex": 0,
    "minQualityIndex": 0,
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "vendor": {}
  },
  "userRates": [
    {}
  ],
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "wordRate": 0
}

POST/api/v3/user/{userUUID}/role/{role}

Add Role for User

Requires: USER_update_roles

path parameters

userUUIDrequired string (uuid)
rolerequired stringUSER ADMIN SYSADMIN ACCOUNT_ADMIN CLIENT CLIENT_ADMIN CLIENT_AGENCY CLIENT_REQUESTER CLIENT_PROJECT_MANAGER PROJECT_MANAGER ACCOUNTING REVIEWER INTERNAL PAYMENTS QUALITY_ISO QUALITY_AUDITOR VENDOR_ADMIN SALES WIKI_MODERATOR WIKI_READONLY WIKI_USER WIKI_ACTIONS WIKI_ADMIN REF_ADMIN REF_USER REF_READONLY VENDOR TERM_TRANSLATOR TERM_REVIEWER TERM_ADMIN TERM_CONTENT_CREATOR TERM_LANGUAGE_MANAGER TERM_UPDATE_REQUESTER TERM_READ_ONLY TERMINOLOGY_STANDALONE_USER TERMINOLOGY_STANDALONE_OWNER

Responses

200 OK

Request

curl -X POST 'https://app.wxrks.com/api/v3/user/{userUUID}/role/{role}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

GET/api/v3/user/{uuid}

Get User

Requires: USER_get_by_id

path parameters

uuidrequired string (uuid)

Responses

200 OK

UserDto

accessKey string
accessKeyTimestamp integer (int64)
accountOwner boolean
accountType stringCLI PERSONAL BUSINESS ENTERPRISE OTHER
accountUuid string (uuid)
address string
address2 string
admin boolean
assignedJobs integer (int64)
avatar string
captcha string
cellPhone string
city string
companyName string
completedJobs integer (int64)
country string
currency string
customFields map<string, object>[]
dailyRate number
defaultWorkflowRates map<string, object>[]
deleteAllLanguagePair boolean
email string
emailMagicCode string
entryPoint stringWORKS_HOME PORTAL_HOME
externalId string
forwardUrl string
hourlyRate number
id integer (int64)
invoicingDayOfMonth stringDAY_15 DAY_30
invoicingPeriodicity integer
lastAccessAt integer (int64)
messageError string
messageWarning string
mfa integer (int64)
mfaEnabled boolean
minimumFee number
name string
nameEmail string
newPassword string
notes string
notifyUser boolean
orgUnits OrganizationalUnitDto[]
organizations OrganizationDto[]
pagesRate number
parentUserUuid string (uuid)
paymentMethod stringPAYONEER PAYPAL BANK QUICKBOOKS
payoneerId string
paypalAccount string
permissionGroups PermissionGroupDto[]
phone string
postalCode string
productName string
punctuality number (double)
quickBooksVendorId string
roles string[]
skypeId string
slackHandle string
state string
status stringActive Inactive Disabled
The user's status. Read ignoring case.
subUser boolean
subscriptions UserSubscriptionDto[]
supportedLanguagePairs LanguagePair[]
tags string[]
targetAccountUuid string (uuid)
tasksCompletedCount integer (int64)
taxId string
taxpayerId string
timezone string
totalJobs integer (int64)
useProjectCurrency boolean
userQualityMetrics UserQualityMetricsDto
userRates UserRateDetailsDto[]
uuid string (uuid)
wordRate number

Request

curl -X GET 'https://app.wxrks.com/api/v3/user/{uuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "accessKey": "string",
  "accessKeyTimestamp": 0,
  "accountOwner": false,
  "accountType": "CLI",
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "address": "string",
  "address2": "string",
  "admin": false,
  "assignedJobs": 0,
  "avatar": "string",
  "captcha": "string",
  "cellPhone": "string",
  "city": "string",
  "companyName": "string",
  "completedJobs": 0,
  "country": "string",
  "currency": "string",
  "customFields": [
    {}
  ],
  "dailyRate": 0,
  "defaultWorkflowRates": [
    {}
  ],
  "deleteAllLanguagePair": false,
  "email": "string",
  "emailMagicCode": "string",
  "entryPoint": "WORKS_HOME",
  "externalId": "string",
  "forwardUrl": "string",
  "hourlyRate": 0,
  "id": 0,
  "invoicingDayOfMonth": "DAY_15",
  "invoicingPeriodicity": 0,
  "lastAccessAt": 0,
  "messageError": "string",
  "messageWarning": "string",
  "mfa": 0,
  "mfaEnabled": false,
  "minimumFee": 0,
  "name": "string",
  "nameEmail": "string",
  "newPassword": "string",
  "notes": "string",
  "notifyUser": false,
  "orgUnits": [
    {}
  ],
  "organizations": [
    {}
  ],
  "pagesRate": 0,
  "parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "paymentMethod": "PAYONEER",
  "payoneerId": "string",
  "paypalAccount": "string",
  "permissionGroups": [
    {}
  ],
  "phone": "string",
  "postalCode": "string",
  "productName": "string",
  "punctuality": 0,
  "quickBooksVendorId": "string",
  "roles": [
    "USER"
  ],
  "skypeId": "string",
  "slackHandle": "string",
  "state": "string",
  "status": "Active",
  "subUser": false,
  "subscriptions": [
    {}
  ],
  "supportedLanguagePairs": [
    {}
  ],
  "tags": [
    "string"
  ],
  "targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tasksCompletedCount": 0,
  "taxId": "string",
  "taxpayerId": "string",
  "timezone": "string",
  "totalJobs": 0,
  "useProjectCurrency": false,
  "userQualityMetrics": {
    "avgQualityIndex": 0,
    "id": 0,
    "maxQualityIndex": 0,
    "minQualityIndex": 0,
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "vendor": {}
  },
  "userRates": [
    {}
  ],
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "wordRate": 0
}

Rates

GET/api/v3/user/{userUuid}/rate

List User Rates

Requires: USER_get_by_id

path parameters

userUuidrequired string (uuid)

query parameters

orgUnitUuid string (uuid)
currency string
scope stringALL DEFAULT ORG_UNIT
sort string
page integer
Page to return, starting at 0.
size integer
Items per page.

Responses

200 OK

UserRateDetailsDto[]

createdAt integer (int64)
currency string
isDefault boolean
minimumFee number
orgUnitUuid string (uuid)
rateDetails RateDetailsDto[]
updatedAt integer (int64)
userUuid string (uuid)
uuid string (uuid)

Request

curl -X GET 'https://app.wxrks.com/api/v3/user/{userUuid}/rate' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

[
  {
    "createdAt": 0,
    "currency": "string",
    "isDefault": false,
    "minimumFee": 0,
    "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "rateDetails": [],
    "updatedAt": 0,
    "userUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
]

POST/api/v3/user/{userUuid}/rate

Create User Rate

Requires: USER_update_billing

path parameters

userUuidrequired string (uuid)

Request body

UserRateDetailsDto

createdAt integer (int64)
currency string
isDefault boolean
minimumFee number
orgUnitUuid string (uuid)
rateDetails RateDetailsDto[]
updatedAt integer (int64)
userUuid string (uuid)
uuid string (uuid)

Responses

201 Created

UserRateDetailsDto

createdAt integer (int64)
currency string
isDefault boolean
minimumFee number
orgUnitUuid string (uuid)
rateDetails RateDetailsDto[]
updatedAt integer (int64)
userUuid string (uuid)
uuid string (uuid)

Request

curl -X POST 'https://app.wxrks.com/api/v3/user/{userUuid}/rate' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "currency": "string",
  "isDefault": false,
  "minimumFee": 0,
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "rateDetails": []
}'

Response 201

{
  "createdAt": 0,
  "currency": "string",
  "isDefault": false,
  "minimumFee": 0,
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "rateDetails": [
    {}
  ],
  "updatedAt": 0,
  "userUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

PUT/api/v3/user/{userUuid}/rate/{userRateUuid}

Update User Rate

Requires: USER_update_billing

path parameters

userUuidrequired string (uuid)
userRateUuidrequired string (uuid)

Request body

UserRateDetailsDto

createdAt integer (int64)
currency string
isDefault boolean
minimumFee number
orgUnitUuid string (uuid)
rateDetails RateDetailsDto[]
updatedAt integer (int64)
userUuid string (uuid)
uuid string (uuid)

Responses

200 OK

UserRateDetailsDto

createdAt integer (int64)
currency string
isDefault boolean
minimumFee number
orgUnitUuid string (uuid)
rateDetails RateDetailsDto[]
updatedAt integer (int64)
userUuid string (uuid)
uuid string (uuid)

Request

curl -X PUT 'https://app.wxrks.com/api/v3/user/{userUuid}/rate/{userRateUuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "currency": "GBP",
  "minimumFee": 0.5
}'

Response 200

{
  "createdAt": 0,
  "currency": "string",
  "isDefault": false,
  "minimumFee": 0,
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "rateDetails": [
    {}
  ],
  "updatedAt": 0,
  "userUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

DELETE/api/v3/user/{userUuid}/rate/{userRateUuid}

Delete User Rate

Requires: USER_update_billing

path parameters

userUuidrequired string (uuid)
userRateUuidrequired string (uuid)

Responses

204 No Content

Request

curl -X DELETE 'https://app.wxrks.com/api/v3/user/{userUuid}/rate/{userRateUuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

PUT/api/v3/user/{userUuid}/rate/{userRateUuid}/default

Set Default User Rate

Requires: USER_update_billing

path parameters

userUuidrequired string (uuid)
userRateUuidrequired string (uuid)

Responses

200 OK

Request

curl -X PUT 'https://app.wxrks.com/api/v3/user/{userUuid}/rate/{userRateUuid}/default' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

DELETE/api/v3/user/{userUuid}/rate/{userRateUuid}/detail/{rateDetailUuid}

Delete User Rate Detail

Requires: USER_update_billing

path parameters

userUuidrequired string (uuid)
userRateUuidrequired string (uuid)
rateDetailUuidrequired string (uuid)

Responses

204 No Content

Request

curl -X DELETE 'https://app.wxrks.com/api/v3/user/{userUuid}/rate/{userRateUuid}/detail/{rateDetailUuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"