Supported Formats

json

Errors

Code Description
403 Forbidden - if you have Public Pool access only

Params

Param name Description
token
required

Token obtained from /authorize

Validations:

  • Must be String

user
required

Validations:

  • Must be a Hash

user[id]
required

Unique ID of the User

Validations:

  • Must be Integer

user[external_id]
optional

An arbitrary value to be associated with this User

Validations:

  • Must be String

user[type]
required

The type of User - Worker = Wonoloer, Employer = Requestor

Validations:

  • Must be one of: Worker, Employer.

user[email]
required

User email - must be unique.

Validations:

  • Must be String

user[password]
required

Password. Minimum 8 characters. Must be specified on creation.

Validations:

  • Must be String

user[password_confirmation]
required

Must be specified and match password, if specified.

Validations:

  • Must be String

user[first_name]
required

User first name - should contain only letters, numbers, dash (-) and period (.) character

Validations:

  • Must be String

user[last_name]
required

User last name - should contain only letters, numbers, dash (-) and period (.) character

Validations:

  • Must be String

user[avatar_url]
optional

Validations:

  • Must be String

user[city]
optional

Validations:

  • Must be String

user[zip]
optional

Validations:

  • Must be String

user[phone]
optional

Validations:

  • Must be String

user[suspended]
optional

True if the User is currently suspended

Validations:

  • Must be one of: true, false.

user[suspended_at]
optional

Validations:

  • Must be DateTime

user[rating]
optional

User's current rating (out of 5.0)

Validations:

  • Must be Float

user[onboarding_last_state]
optional

Worker's last onboarding state

Validations:

  • Must be one of: not_started, take_quiz, take_background_check, schedule_call, call, pending_background_check, complete, rejected, error, invited, uninvited.

user[w2_onboarding_status]
optional

Worker's current W2 onboarding status

Validations:

  • Must be one of: not_started, started, pending, completed, queued.

user[w2_employee_id]
optional

Worker's unique employee ID for W2 classified jobs

Validations:

  • Must be String

user[address_state]
optional

Validations:

  • Must be String

user[drug_tested]
optional

Worker's drug test results

Validations:

  • Must be one of: passed, failed.

user[gender]
optional

User's gender

Validations:

  • Must be String

user[w2_onboarding_started]
optional

When the worker started W2 onboarding

Validations:

  • Must be DateTime

user[verified_phone]
optional

Validations:

  • Must be String

user[phone_verified_at]
optional

Validations:

  • Must be DateTime

user[agreed_to_terms]
optional

Validations:

  • Must be one of: true, false.

user[agreed_to_terms_date]
optional

Validations:

  • Must be DateTime

user[synced_worker_id]
required

the id of user on the external server for sync

Validations:

  • Must be Integer

user[user_badges_attributes]
optional

Badges that the User has

Validations:

  • Must be a Hash

user[user_badges_attributes][badge_id]
required

The ID of the Badge

Validations:

  • Must be Integer

user[user_badges_attributes][id]
optional

The ID of the current User-Badge association between this user and a badge - required for the '_destroy' function below

Validations:

  • Must be Integer

user[user_badges_attributes][_destroy]
optional

set to remove this User-Badge association on updating a User (PATCH)

Validations:

  • Must be one of: true.