Customers

Supported Formats

json
>>>

GET /api_v2/customers
List Customers belonging to a Company

Returns a list of Customers belonging to a Company, optionally paginated. Note: the maximum number returned per page in any case is 50.

Supported Formats

json

Errors

Code Description
401 Unauthorized

Params

Param name Description
token
required

Token obtained from /authenticate

Validations:

  • Must be a String
page
optional

The page number to start from

Validations:

  • Must be a Integer
per
optional

The size of the page

Validations:

  • Must be a Integer
>>>

GET /api_v2/customers/:id
Get a specific Customer

Supported Formats

json

Errors

Code Description
404 Not found. No Customer with the specified ID can be found

Params

Param name Description
token
required

Token obtained from /authenticate

Validations:

  • Must be a String
id
required

ID of Customer

Validations:

  • Must be a Integer
>>>

POST /api_v2/customers
Create a Customer

Supported Formats

json

Errors

Code Description
422 Could not save the Customer

Params

Param name Description
token
required

Token obtained from /authenticate

Validations:

  • Must be a String
customer
required

Customer Info

Validations:

  • Must be a Hash
customer[name]
required

Customer Name

Validations:

  • Must be a String
customer[account_owner]
optional

Customer Name

Validations:

  • Must be a String
customer[account_manager]
optional

Account Owner

Validations:

  • Must be a String
customer[address]
optional

Address

Validations:

  • Must be a String
customer[city]
optional

City

Validations:

  • Must be a String
customer[state]
optional

State

Validations:

  • Must be a String
customer[zip]
optional

Zip

Validations:

  • Must be a String
customer[phone]
optional

Phone

Validations:

  • Must be a String
customer[contact_first_name]
optional

Contact Last Name

Validations:

  • Must be a String
customer[contact_last_name]
optional

Contact Last Name

Validations:

  • Must be a String
customer[contact_email]
optional

Contact Email

Validations:

  • Must be a String
customer[billing_first_name]
optional

Billing First Name - must be between 1 and 50 characters in length

Validations:

  • Must be a String
customer[billing_last_name]
optional

Billing Last Name - must be between 1 and 50 characters in length

Validations:

  • Must be a String
customer[billing_email]
optional

Billing Email - must be between 1 and 255 characters in length

Validations:

  • Must be a String
customer[billing_phone]
optional

Billing Phone - must be between 1 and 50 characters in length

Validations:

  • Must be a String
customer[fee_percentage]
optional

Fee Percentage - must be between 0.0 and 1.0

Validations:

  • Must be a Float
customer[can_post_w2]
optional

True if this Customer can post w2 job requests. Default is False when not set

Validations:

  • Must be one of: true, false, 1, 0.
customer[can_post_1099]
optional

True if this Customer can post 1099 job request. Default is True when not set

Validations:

  • Must be one of: true, false, 1, 0.
customer[use_start_and_complete_pin]
optional

True if this Customer can use Start and Complete Pin. Default is False when left blank or not set

Validations:

  • Must be one of: true, false, 1, 0.
customer[strategic_pilot]
optional

True if this Customer is strategic pilot

Validations:

  • Must be one of: true, false, 1, 0.
customer[use_pending_state]
optional

True if this Customer can use Pending Workflow. Default is False when not set

Validations:

  • Must be one of: true, false, 1, 0.
customer[credit_limit]
optional

Credit Limit - must be greater than or equal to 20000 for a strategic pilot customer

Validations:

  • Must be a Integer
customer[notification_distance]
optional

The maximum distance in MILES between Request and Worker to send job push notifications to. Overrides any default setting at Company level.

Validations:

  • Must be a Integer
customer[use_location_validation]
optional

True if this Customer can use check-in geofencing. Default is True when not set

Validations:

  • Must be one of: true, false, 1, 0.
customer[location_validation_radius]
optional

The maximum radius in MILES in which the Wonoloer can start/complete a job. Default is 0.2 mile when not set

Validations:

  • Must be a Float
customer[check_out_geofencing]
optional

True if this Customer can use check-out geofencing. Default is True when not set

Validations:

  • Must be one of: true, false, 1, 0.
>>>

Supported Formats

json

Errors

Code Description
404 Not found. No Customer with the specified ID can be found
422 Could not save the Customer

Params

Param name Description
token
required

Token obtained from /authenticate

Validations:

  • Must be a String
id
required

ID of Customer

Validations:

  • Must be a Integer
customer
required

Customer Info

Validations:

  • Must be a Hash
customer[name]
required

Customer Name

Validations:

  • Must be a String
customer[account_owner]
optional

Customer Name

Validations:

  • Must be a String
customer[account_manager]
optional

Account Owner

Validations:

  • Must be a String
customer[address]
optional

Address

Validations:

  • Must be a String
customer[city]
optional

City

Validations:

  • Must be a String
customer[state]
optional

State

Validations:

  • Must be a String
customer[zip]
optional

Zip

Validations:

  • Must be a String
customer[phone]
optional

Phone

Validations:

  • Must be a String
customer[contact_first_name]
optional

Contact Last Name

Validations:

  • Must be a String
customer[contact_last_name]
optional

Contact Last Name

Validations:

  • Must be a String
customer[contact_email]
optional

Contact Email

Validations:

  • Must be a String
customer[billing_first_name]
optional

Billing First Name - must be between 1 and 50 characters in length

Validations:

  • Must be a String
customer[billing_last_name]
optional

Billing Last Name - must be between 1 and 50 characters in length

Validations:

  • Must be a String
customer[billing_email]
optional

Billing Email - must be between 1 and 255 characters in length

Validations:

  • Must be a String
customer[billing_phone]
optional

Billing Phone - must be between 1 and 50 characters in length

Validations:

  • Must be a String
customer[fee_percentage]
optional

Fee Percentage - must be between 0.0 and 1.0

Validations:

  • Must be a Float
customer[can_post_w2]
optional

True if this Customer can post w2 job requests. Default is False when not set

Validations:

  • Must be one of: true, false, 1, 0.
customer[can_post_1099]
optional

True if this Customer can post 1099 job request. Default is True when not set

Validations:

  • Must be one of: true, false, 1, 0.
customer[use_start_and_complete_pin]
optional

True if this Customer can use Start and Complete Pin. Default is False when left blank or not set

Validations:

  • Must be one of: true, false, 1, 0.
customer[strategic_pilot]
optional

True if this Customer is strategic pilot

Validations:

  • Must be one of: true, false, 1, 0.
customer[use_pending_state]
optional

True if this Customer can use Pending Workflow. Default is False when not set

Validations:

  • Must be one of: true, false, 1, 0.
customer[credit_limit]
optional

Credit Limit - must be greater than or equal to 20000 for a strategic pilot customer

Validations:

  • Must be a Integer
customer[notification_distance]
optional

The maximum distance in MILES between Request and Worker to send job push notifications to. Overrides any default setting at Company level.

Validations:

  • Must be a Integer
customer[use_location_validation]
optional

True if this Customer can use check-in geofencing. Default is True when not set

Validations:

  • Must be one of: true, false, 1, 0.
customer[location_validation_radius]
optional

The maximum radius in MILES in which the Wonoloer can start/complete a job. Default is 0.2 mile when not set

Validations:

  • Must be a Float
customer[check_out_geofencing]
optional

True if this Customer can use check-out geofencing. Default is True when not set

Validations:

  • Must be one of: true, false, 1, 0.
>>>

GET /api_v2/customers/exists
Check for existing of Customer by name

Supported Formats

json

Errors

Code Description
404 Not found. No Customer with keyword can be found

Params

Param name Description
token
required

Token obtained from /authenticate

Validations:

  • Must be a String
name
required

Name of Customer

Validations:

  • Must be a String