Skip to content

Get Offer Recommendations

GET
/offers/{offerId}/recommendations

Get offer recommendations for a professional based on another offer

offerId
required
string

Offer ID

OK

object
offers
Array<object>
object
autofillOptions

AutoFillOptions are options for job to be auto filled based on the options provided.

object
favorite
boolean
consent

Consent

created_at
string
2021-01-01T08:00:00Z
distance
number
10
favorite

This indicates whether the office of the offer has favorited the user

boolean
id
string
1234567890123456
insuranceAmount

Mobile-app accept this field on camel case

integer
is_lunch_break_paid
boolean
true
isAssistedHygiene
boolean
true
isFavorite

Mobile-app accept this field on camel case (offer details only)

boolean
isUrgent

Urgent shift info

boolean
job_datetime
string
2021-01-01T08:00:00Z
job_datetime_end
string
2021-01-01T17:00:00Z
job_status
string
open
jobType

TEMP, ONSITE_INTERVIEW

string
Allowed values: TEMP ONSITE_INTERVIEW
knowByTime

Need to Know by time

Array<string>
local_date
string
local_end_time
string
local_start_time
string
local_timezone
string
lunch_final_break_time
string
30
multi_day_booking
string
notification

Notification are detail of re-execution of job’s notification

object
retriggerAt
string
retriggerCount
integer
offer_owner
object
address
Array<object>
object
city
string
formatted_address
string
latitude
string
longitude
string
postal_code
string
state
string
id
string
office_info
object
bestInDentalYears
Array<integer>
insurances
Array<string>
is_dso
boolean
is_info_asked
boolean
isAssistedHygiene
boolean
officeRating
number
officeType
string
patients_per_hour
string
patients_per_hour_da
string
patients_per_hour_dn
string
softwares
Array<string>
timePerPatientDA
string
timePerPatientDN
string
timePerPatientRDH
string
office_name
string
parking_info
string
parking_type
string
patientsPerHour

Mobile-app accept this field on camel case

string
prefer_type
string
procedures
Array<string>
[
"Cleaning"
]
profession
string
DA
professionName

Mobile-app accept this field on camel case

string
Dental Assistant
rate
integer
100
recommendation_type
string
Allowed values: same-date same-weekday highest-tdp
same-date
scheduled

Scheduled indicates whether the offer is scheduled or not.

boolean
skills

Kept for backward compatibility, should use skillCodes instead

Array<object>
object
code
string
name
string
optional
boolean
priority
integer
skills_codes

Mobile-app will map the code names on their side

Array<string>
specialty
string
General Dentistry
state
string
FL
subProfession
string
EFDA
subProfessionName
string
Expanded Functions Dental Assistant
timePerPatient
string
30 min
timezone
string
America/New_York
total
number
100
totalHourls
integer
8
urgentShift
object
bonusPay
integer
bonusRatio
number
worker_classification
string
contractor
workingHourls
number
8

Bad Request

object
error
string
some meaningful error message

Unauthorized

object
error
string
some meaningful error message

Internal Server Error

object
error
string
some meaningful error message