API Reference

Predict-match a Employee record

post
https://{subdomain}.{region}.deputy.com/api/v1/resource/Employee/PREDICT

Returns the closest matching existing record for a partial payload. Used by upsert-style integrations to find an existing row before creating.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
integer
required
string
required
length ≤ 64
string
required
length ≤ 64
string
required
length ≤ 255
string
length ≤ 64
string
length ≤ 32
integer
integer
integer
required
integer
date-time
integer
integer
string
length ≤ 64
integer
integer
integer
boolean
required
date-time
date-time
date-time
string
string
string
length ≤ 255
integer
string
length ≤ 255
boolean
integer
required
boolean
required
integer
integer
string
length ≤ 64
string
length ≤ 64
integer
date-time
string
required
CompanyObject
object
MainAddressObject
object
PostalAddressObject
object
ContactObject
object
EmergencyAddressObject
object
PhotoObject
object
User
object
JobApp
object
StressProfileObject
object
RoleObject
object
CustomFieldDataObject
object
boolean
Responses

400

Bad request

401

Authentication required or invalid token

403

Forbidden — token lacks access to this resource

404

Resource not found

Updated 3 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?