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[type]
required

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

Validations:

  • Must be one of: Worker, Employer.

user[gender]
optional

User's gender

Validations:

  • Must be String

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[address]
optional

Validations:

  • Must be String

user[city]
optional

Validations:

  • Must be String

user[address_state]
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[agreed_to_terms]
optional

True if the User has agreed to terms

Validations:

  • Must be one of: true, false.

user[agreed_to_terms_date]
optional

Validations:

  • Must be DateTime

user[external_id]
optional

An arbitrary value to be associated with this Worker. This attribute is used for Workers only.

Validations:

  • Must be String

user[onboarding_last_state]
optional

Worker's last onboarding state. This attribute is used for Workers only.

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. This attribute is used for Workers only.

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. This attribute is used for Workers only.

Validations:

  • Must be String

user[drug_tested]
optional

Worker's drug test results. This attribute is used for Workers only.

Validations:

  • Must be one of: passed, failed.

user[w2_onboarding_started]
optional

When the Worker started W2 onboarding. This attribute is used for Workers only.

Validations:

  • Must be DateTime

user[verified_phone]
optional

Worker's verified phone. This attribute is used for Workers only.

Validations:

  • Must be String

user[phone_verified_at]
optional

This attribute is used for Workers only.

Validations:

  • Must be DateTime

user[synced_worker_id]
required

Worker's ID on an external server, used for syncing purposes. This attribute is used for Workers only.

Validations:

  • Must be Integer

user[user_badges_attributes]
optional

Badges that the Worker has. This attribute is used for Workers only.

Validations:

  • Must be a Hash

user[user_badges_attributes][badge_id]
required

The ID of the Badge. This attribute is used for Workers only.

Validations:

  • Must be Integer

user[user_badges_attributes][id]
optional

The ID of the current User-Badge association between this Worker and a badge - required for the '_destroy' function below. This attribute is used for Workers only.

Validations:

  • Must be Integer

user[user_badges_attributes][_destroy]
optional

Set to remove this User-Badge association on updating a Worker (PATCH). This attribute is used for Workers only.

Validations:

  • Must be one of: true.

user[title]
optional

Employer's title. This attribute is used for Employers only.

Validations:

  • Must be String

user[role]
required

Employer's role. This attribute is used for Employers only.

Validations:

  • Must be one of: customer_admin, requestor, read_only.

user[customer_id]
required

Employer's customer ID. This attribute is used for Employers only.

Validations:

  • Must be Integer