Skip to content

Deel: Talent schemas

12 Deel schemas with complete fields and constraints.

← Talent operations · All schemas

List candidates — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentThe candidates on the requested page.
data[]ModelEach itemExpand List candidates — 200 response body — data item
pageModelRequired within parentExpand List candidates — 200 response body — page
Pagination details.

Referenced models: List candidates — 200 response body — data item, List candidates — 200 response body — page

List candidates — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentWhen the candidate was submitted.
Format: date-time
creation_sourcestringRequired within parentHow the candidate was sourced: by a talent partner or by an external provider.
Known values: HACKAJOB, VMS_VENDOR
emailJSONRequired within parent
email (anyOf 1)stringAlternativeCandidate email. `null` when the talent partner did not share it.
Format: email
email (anyOf 2)nullAlternativeCandidate email. `null` when the talent partner did not share it.
Format: email
first_namestringRequired within parentCandidate first name.
full_namestringRequired within parentCandidate full name.
idstringRequired within parentUnique identifier of the candidate.
Format: uuid
last_namestringRequired within parentCandidate last name.
requisition_idstringRequired within parentIdentifier of the job request the candidate was submitted to.
Format: uuid
statusstringRequired within parentCurrent pipeline status of the candidate.
Known values: CANCELLED_BY_HIRER, CANCELLED_BY_VENDOR, CONTRACT_CREATED, INITIAL_SCREENING_REJECTED, INTERVIEW_REJECTED, OFFER_ACCEPTED, OFFER_REJECTED, OFFER_SENT, PENDING_INITIAL_SCREENING, PENDING_INTERVIEW, WAITING_FOR_OFFER
status_updated_atstringRequired within parentWhen the candidate status last changed.
Format: date-time
vendorJSONRequired within parentTalent partner that submitted the candidate. `null` when sourced from an external provider.
vendor (anyOf 1)ModelAlternativeExpand List candidates — 200 response body — data item vendor id, name
vendor (anyOf 2)nullAlternative

Referenced models: List candidates — 200 response body — data item vendor id, name

List candidates — 200 response body — data item vendor id, name

FieldTypePresenceDescription and constraints
$objectRootTalent partner that submitted the candidate. `null` when sourced from an external provider.
idstringRequired within parentUnique identifier of the talent partner.
Format: uuid
namestringRequired within parentTalent partner name.

List candidates — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRootPagination details.
cursorstringRequired within parentCursor to pass to the next request. Still set on the last page; the end of the list is reached when a request returns an empty `data` and an empty cursor.
total_rowsJSONRequired within parent
total_rows (anyOf 1)JSONAlternative
total_rows (anyOf 1) (anyOf 1)integerAlternativeTotal number of candidates matching the filters. Returned on the first page only, `null` afterwards.
total_rows (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_rows (anyOf 2)nullAlternativeTotal number of candidates matching the filters. Returned on the first page only, `null` afterwards.

List job requests — talent list Requisitions — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentThe job requests on the requested page.
data[]ModelEach itemExpand List job requests — talent list Requisitions — 200 response body — data item
pageModelRequired within parentExpand List job requests — talent list Requisitions — 200 response body — page
Pagination metadata.

Referenced models: List job requests — talent list Requisitions — 200 response body — page, List job requests — talent list Requisitions — 200 response body — data item

List job requests — talent list Requisitions — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
approval_policy_idJSONOptional
approval_policy_id (anyOf 1)stringAlternativeIdentifier of the approval policy applied to the job request.
approval_policy_id (anyOf 2)nullAlternativeIdentifier of the approval policy applied to the job request.
approval_statusstringOptionalApproval status of the job request.
Known values: NOT_REQUESTED, REQUESTED, APPROVED, REJECTED, CANCELLED
candidate_countJSONOptional
candidate_count (anyOf 1)integerAlternativeTotal number of candidates on the job request.
candidate_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
candidate_limitJSONOptional
candidate_limit (anyOf 1)JSONAlternative
candidate_limit (anyOf 1) (anyOf 1)integerAlternativeMaximum number of candidates each talent partner may submit.
candidate_limit (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
candidate_limit (anyOf 2)nullAlternativeMaximum number of candidates each talent partner may submit.
close_noteJSONOptional
close_note (anyOf 1)stringAlternativeFree-text note recorded when closing the job request.
close_note (anyOf 2)nullAlternativeFree-text note recorded when closing the job request.
close_reasonJSONOptional
close_reason (anyOf 1)stringAlternativeReason the job request was closed.
close_reason (anyOf 2)nullAlternativeReason the job request was closed.
contract_length_typeJSONOptionalWhether the engagement is fixed-term or indefinite.
contract_length_type (anyOf 1)stringAlternativeWhether the engagement is fixed-term or indefinite.
Known values: FIXED, INDEFINITE
contract_length_type (anyOf 2)nullAlternative
contract_typeJSONOptionalContract type of the job request.
contract_type (anyOf 1)stringAlternativeContract type of the job request.
Known values: EMPLOYEE, CONTRACTOR
contract_type (anyOf 2)nullAlternative
created_atstringOptionalWhen the job request was created.
Format: date-time
currencyJSONOptional
currency (anyOf 1)stringAlternativeISO 4217 currency code of the rate.
currency (anyOf 2)nullAlternativeISO 4217 currency code of the rate.
descriptionJSONOptional
description (anyOf 1)stringAlternativeJob request description.
description (anyOf 2)nullAlternativeJob request description.
employment_typeJSONOptionalEmployment type.
employment_type (anyOf 1)stringAlternativeEmployment type.
Known values: FULL_TIME, PART_TIME
employment_type (anyOf 2)nullAlternative
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeRequested end date.
Format: date-time
end_date (anyOf 2)nullAlternativeRequested end date.
Format: date-time
has_non_vendor_candidatesbooleanOptionalWhether the job request has candidates not sourced through a talent partner.
hours_per_monthJSONOptional
hours_per_month (anyOf 1)JSONAlternative
hours_per_month (anyOf 1) (anyOf 1)integerAlternativeExpected hours per month.
hours_per_month (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hours_per_month (anyOf 2)nullAlternativeExpected hours per month.
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of the job request.
id (anyOf 2)nullAlternativeUnique identifier of the job request.
job_familyJSONOptional
job_family (anyOf 1)stringAlternativeJob family.
job_family (anyOf 2)nullAlternativeJob family.
locationsJSONOptional
locations (anyOf 1)arrayAlternativeISO 3166-1 alpha-2 country codes the job request targets.
locations (anyOf 1)[]stringEach item
locations (anyOf 2)nullAlternativeISO 3166-1 alpha-2 country codes the job request targets.
locations (anyOf 2)[]stringEach item
marked_as_inactive_atJSONOptional
marked_as_inactive_at (anyOf 1)stringAlternativeWhen the job request was flagged as inactive, if it was.
Format: date-time
marked_as_inactive_at (anyOf 2)nullAlternativeWhen the job request was flagged as inactive, if it was.
Format: date-time
organizationModelOptionalExpand List job requests — talent list Requisitions — 200 response body — data item organization
Organization the job request belongs to.
pending_initial_screening_candidates_countJSONOptional
pending_initial_screening_candidates_count (anyOf 1)integerAlternativeCandidates awaiting initial screening. Returned as `0` when the token owner is only an approver on the job request.
pending_initial_screening_candidates_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pending_interview_candidates_countJSONOptional
pending_interview_candidates_count (anyOf 1)integerAlternativeCandidates awaiting an interview. Returned as `0` when the token owner is only an approver on the job request.
pending_interview_candidates_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantityJSONOptional
quantity (anyOf 1)integerAlternativeNumber of open positions.
quantity (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate_maxJSONOptional
rate_max (anyOf 1)JSONAlternative
rate_max (anyOf 1) (anyOf 1)numberAlternativeUpper bound of the rate range.
Format: double
rate_max (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate_max (anyOf 2)nullAlternativeUpper bound of the rate range.
Format: double
rate_minJSONOptional
rate_min (anyOf 1)JSONAlternative
rate_min (anyOf 1) (anyOf 1)numberAlternativeLower bound of the rate range.
Format: double
rate_min (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate_min (anyOf 2)nullAlternativeLower bound of the rate range.
Format: double
rate_scaleJSONOptionalScale the rate range is expressed in.
rate_scale (anyOf 1)stringAlternativeScale the rate range is expressed in.
Known values: HOURLY, MILESTONE, DAILY, WEEKLY, MONTHLY, ANNUAL
rate_scale (anyOf 2)nullAlternative
ready_for_offer_candidates_countJSONOptional
ready_for_offer_candidates_count (anyOf 1)integerAlternativeCandidates ready to receive an offer. Returned as `0` when the token owner is only an approver on the job request.
ready_for_offer_candidates_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ready_to_hire_candidates_countJSONOptional
ready_to_hire_candidates_count (anyOf 1)integerAlternativeCandidates who accepted an offer and are ready to be hired. Returned as `0` when the token owner is only an approver on the job request.
ready_to_hire_candidates_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
service_statusJSONOptionalWhether Deel can service the job request.
service_status (anyOf 1)stringAlternativeWhether Deel can service the job request.
Known values: PENDING, SERVICEABLE, NOT_SERVICEABLE
service_status (anyOf 2)nullAlternative
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeRequested start date.
Format: date-time
start_date (anyOf 2)nullAlternativeRequested start date.
Format: date-time
statusstringOptionalJob request status.
Known values: ACTIVE, PAUSED, CLOSED, NOT_SHARED
titlestringOptionalJob request title.
total_hired_candidatesJSONOptional
total_hired_candidates (anyOf 1)integerAlternativeNumber of candidates hired on this job request.
total_hired_candidates (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_vendorsJSONOptional
total_vendors (anyOf 1)integerAlternativeNumber of talent partners attached to the job request.
total_vendors (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_vendors_per_statusobjectOptionalCount of attached talent partners per status.
Additional keys: see wildcard field
total_vendors_per_status.*JSONAdditional keys
total_vendors_per_status.* (anyOf 1)integerAlternative
total_vendors_per_status.* (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringOptionalWhen the job request was last updated.
Format: date-time
vendorsarrayOptionalTalent partners attached to the job request.
vendors[]ModelEach itemExpand List job requests — talent list Requisitions — 200 response body — data item vendors item
work_modeJSONOptionalWork mode.
work_mode (anyOf 1)stringAlternativeWork mode.
Known values: REMOTE, OFFICE, HYBRID
work_mode (anyOf 2)nullAlternative
yoe_minJSONOptional
yoe_min (anyOf 1)JSONAlternative
yoe_min (anyOf 1) (anyOf 1)integerAlternativeMinimum years of experience required.
yoe_min (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
yoe_min (anyOf 2)nullAlternativeMinimum years of experience required.

Referenced models: List job requests — talent list Requisitions — 200 response body — data item organization, List job requests — talent list Requisitions — 200 response body — data item vendors item

List job requests — talent list Requisitions — 200 response body — data item organization

FieldTypePresenceDescription and constraints
$objectRootOrganization the job request belongs to.
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of the organization.
id (anyOf 2)nullAlternativeUnique identifier of the organization.
nameJSONOptional
name (anyOf 1)stringAlternativeOrganization name.
name (anyOf 2)nullAlternativeOrganization name.

List job requests — talent list Requisitions — 200 response body — data item vendors item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalWhen the talent partner was attached.
Format: date-time
fee_typestringOptionalAgreed fee type.
Known values: ONE_TIME_FIXED, ONE_TIME_PERCENTAGE, RECURRING_FIXED, RECURRING_PERCENTAGE, DEPRECATED
fee_valueJSONOptional
fee_value (anyOf 1)numberAlternativeAgreed fee value.
Format: double
fee_value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hirer_withdrawn_reasonJSONOptional
hirer_withdrawn_reason (anyOf 1)stringAlternativeReason the client withdrew the talent partner.
hirer_withdrawn_reason (anyOf 2)nullAlternativeReason the client withdrew the talent partner.
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of the talent partner.
id (anyOf 2)nullAlternativeUnique identifier of the talent partner.
logo_urlJSONOptional
logo_url (anyOf 1)stringAlternativeTalent partner logo URL.
logo_url (anyOf 2)nullAlternativeTalent partner logo URL.
namestringOptionalName of the talent partner.
rejected_reasonJSONOptional
rejected_reason (anyOf 1)stringAlternativeReason the talent partner rejected the job request.
rejected_reason (anyOf 2)nullAlternativeReason the talent partner rejected the job request.
statusstringOptionalStatus of the talent partner on this job request.
Known values: APPROVED, REJECTED, PENDING_APPROVAL, HIDDEN_BY_HIRER, WITHDRAWN_BY_HIRER, WITHDRAWN_BY_VENDOR
status_updated_atstringOptionalWhen the status last changed.
Format: date-time
updated_atstringOptionalWhen the attachment was last updated.
Format: date-time
vendor_withdrawn_reasonJSONOptional
vendor_withdrawn_reason (anyOf 1)stringAlternativeReason the talent partner withdrew.
vendor_withdrawn_reason (anyOf 2)nullAlternativeReason the talent partner withdrew.
work_order_statusstringOptionalStatus of the associated work order.
Known values: NOT_REQUIRED, AWAITING_CREATION, PENDING_VENDOR_SIGNATURE, REJECTED_BY_VENDOR, REJECTED_DUE_TO_INACTIVITY, REJECTED_BY_HIRER, SIGNED
work_order_status_updated_atJSONOptional
work_order_status_updated_at (anyOf 1)stringAlternativeWhen the work order status last changed.
Format: date-time
work_order_status_updated_at (anyOf 2)nullAlternativeWhen the work order status last changed.
Format: date-time

List job requests — talent list Requisitions — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRootPagination metadata.
cursorstringRequired within parentCursor to pass to the next request. Empty when no records remain.
total_rowsJSONRequired within parent
total_rows (anyOf 1)integerAlternativeTotal number of job requests matching the filters.
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List job requests — talent list Requisitions — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
searchstringOptionalMaximum length: 150
vendor_idsarrayOptional
vendor_ids[]stringEach item
contract_typearrayOptional
contract_type[]stringEach itemOne of: EMPLOYEE, CONTRACTOR
rate_scalestringOptionalOne of: HOURLY, MILESTONE, DAILY, WEEKLY, MONTHLY, ANNUAL
locationsarrayOptional
locations[]stringEach itemMaximum length: 2
work_modestringOptionalOne of: REMOTE, OFFICE, HYBRID
statusarrayOptional
status[]stringEach itemOne of: ACTIVE, PAUSED, CLOSED, NOT_SHARED
approval_statusarrayOptional
approval_status[]stringEach itemOne of: NOT_REQUESTED, REQUESTED, APPROVED, REJECTED, CANCELLED
start_date_fromstringOptionalFormat: date-time
start_date_tostringOptionalFormat: date-time
end_date_fromstringOptionalFormat: date-time
end_date_tostringOptionalFormat: date-time
created_at_fromstringOptionalFormat: date-time
created_at_tostringOptionalFormat: date-time
request_typestringOptionalDefault: GENERAL
One of: GENERAL, PENDING_TASKS
sort_bystringOptionalDefault: created_at
One of: n_candidates, n_positions, rate_min, rate_max, created_at, start_date, end_date, status
sort_orderstringOptionalDefault: ASC
One of: ASC, DESC
cursorstringOptional
limitintegerOptionalDefault: 10
Maximum: 100
Minimum: 1

List job requests — talent list Talent Requisitions — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentThe job requests on the requested page.
data[]ModelEach itemExpand List job requests — talent list Talent Requisitions — 200 response body — data item
pageModelRequired within parentExpand List job requests — talent list Requisitions — 200 response body — page
Pagination metadata.

Referenced models: List job requests — talent list Talent Requisitions — 200 response body — data item, List job requests — talent list Requisitions — 200 response body — page

List job requests — talent list Talent Requisitions — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
approval_policy_idJSONOptional
approval_policy_id (anyOf 1)stringAlternativeIdentifier of the approval policy applied to the job request.
approval_policy_id (anyOf 2)nullAlternativeIdentifier of the approval policy applied to the job request.
approval_statusstringOptionalApproval status of the job request.
Known values: NOT_REQUESTED, REQUESTED, APPROVED, REJECTED, CANCELLED
ats_job_idJSONOptional
ats_job_id (anyOf 1)stringAlternativeIdentifier of the Deel ATS job linked to the job request, or `null` when none is linked. Use it with the `/rest/ats/` endpoints, for example to list the applications of that job.
Format: uuid
ats_job_id (anyOf 2)nullAlternativeIdentifier of the Deel ATS job linked to the job request, or `null` when none is linked. Use it with the `/rest/ats/` endpoints, for example to list the applications of that job.
Format: uuid
ats_opening_idJSONOptional
ats_opening_id (anyOf 1)stringAlternativeIdentifier of the Deel ATS job opening linked to the job request, or `null` when none is linked. Use it with the `/rest/ats/` endpoints.
Format: uuid
ats_opening_id (anyOf 2)nullAlternativeIdentifier of the Deel ATS job opening linked to the job request, or `null` when none is linked. Use it with the `/rest/ats/` endpoints.
Format: uuid
candidate_countJSONOptional
candidate_count (anyOf 1)integerAlternativeTotal number of candidates on the job request.
candidate_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
candidate_limitJSONOptional
candidate_limit (anyOf 1)JSONAlternative
candidate_limit (anyOf 1) (anyOf 1)integerAlternativeMaximum number of candidates each talent partner may submit.
candidate_limit (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
candidate_limit (anyOf 2)nullAlternativeMaximum number of candidates each talent partner may submit.
close_noteJSONOptional
close_note (anyOf 1)stringAlternativeFree-text note recorded when closing the job request.
close_note (anyOf 2)nullAlternativeFree-text note recorded when closing the job request.
close_reasonJSONOptional
close_reason (anyOf 1)stringAlternativeReason the job request was closed.
close_reason (anyOf 2)nullAlternativeReason the job request was closed.
contract_length_typeJSONOptionalWhether the engagement is fixed-term or indefinite.
contract_length_type (anyOf 1)stringAlternativeWhether the engagement is fixed-term or indefinite.
Known values: FIXED, INDEFINITE
contract_length_type (anyOf 2)nullAlternative
contract_typeJSONOptionalContract type of the job request.
contract_type (anyOf 1)stringAlternativeContract type of the job request.
Known values: EMPLOYEE, CONTRACTOR
contract_type (anyOf 2)nullAlternative
created_atstringOptionalWhen the job request was created.
Format: date-time
currencyJSONOptional
currency (anyOf 1)stringAlternativeISO 4217 currency code of the rate.
currency (anyOf 2)nullAlternativeISO 4217 currency code of the rate.
descriptionJSONOptional
description (anyOf 1)stringAlternativeJob request description.
description (anyOf 2)nullAlternativeJob request description.
employment_typeJSONOptionalEmployment type.
employment_type (anyOf 1)stringAlternativeEmployment type.
Known values: FULL_TIME, PART_TIME
employment_type (anyOf 2)nullAlternative
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeRequested end date.
Format: date-time
end_date (anyOf 2)nullAlternativeRequested end date.
Format: date-time
has_non_vendor_candidatesbooleanOptionalWhether the job request has candidates not sourced through a talent partner.
hours_per_monthJSONOptional
hours_per_month (anyOf 1)JSONAlternative
hours_per_month (anyOf 1) (anyOf 1)integerAlternativeExpected hours per month.
hours_per_month (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hours_per_month (anyOf 2)nullAlternativeExpected hours per month.
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of the job request.
id (anyOf 2)nullAlternativeUnique identifier of the job request.
job_familyJSONOptional
job_family (anyOf 1)stringAlternativeJob family.
job_family (anyOf 2)nullAlternativeJob family.
locationsJSONOptional
locations (anyOf 1)arrayAlternativeISO 3166-1 alpha-2 country codes the job request targets.
locations (anyOf 1)[]stringEach item
locations (anyOf 2)nullAlternativeISO 3166-1 alpha-2 country codes the job request targets.
locations (anyOf 2)[]stringEach item
marked_as_inactive_atJSONOptional
marked_as_inactive_at (anyOf 1)stringAlternativeWhen the job request was flagged as inactive, if it was.
Format: date-time
marked_as_inactive_at (anyOf 2)nullAlternativeWhen the job request was flagged as inactive, if it was.
Format: date-time
organizationModelOptionalExpand List job requests — talent list Requisitions — 200 response body — data item organization
Organization the job request belongs to.
pending_initial_screening_candidates_countJSONOptional
pending_initial_screening_candidates_count (anyOf 1)integerAlternativeCandidates awaiting initial screening. Returned as `0` when the token owner is only an approver on the job request.
pending_initial_screening_candidates_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pending_interview_candidates_countJSONOptional
pending_interview_candidates_count (anyOf 1)integerAlternativeCandidates awaiting an interview. Returned as `0` when the token owner is only an approver on the job request.
pending_interview_candidates_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantityJSONOptional
quantity (anyOf 1)integerAlternativeNumber of open positions.
quantity (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate_maxJSONOptional
rate_max (anyOf 1)JSONAlternative
rate_max (anyOf 1) (anyOf 1)numberAlternativeUpper bound of the rate range.
Format: double
rate_max (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate_max (anyOf 2)nullAlternativeUpper bound of the rate range.
Format: double
rate_minJSONOptional
rate_min (anyOf 1)JSONAlternative
rate_min (anyOf 1) (anyOf 1)numberAlternativeLower bound of the rate range.
Format: double
rate_min (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate_min (anyOf 2)nullAlternativeLower bound of the rate range.
Format: double
rate_scaleJSONOptionalScale the rate range is expressed in.
rate_scale (anyOf 1)stringAlternativeScale the rate range is expressed in.
Known values: HOURLY, MILESTONE, DAILY, WEEKLY, MONTHLY, ANNUAL
rate_scale (anyOf 2)nullAlternative
ready_for_offer_candidates_countJSONOptional
ready_for_offer_candidates_count (anyOf 1)integerAlternativeCandidates ready to receive an offer. Returned as `0` when the token owner is only an approver on the job request.
ready_for_offer_candidates_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ready_to_hire_candidates_countJSONOptional
ready_to_hire_candidates_count (anyOf 1)integerAlternativeCandidates who accepted an offer and are ready to be hired. Returned as `0` when the token owner is only an approver on the job request.
ready_to_hire_candidates_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
service_statusJSONOptionalWhether Deel can service the job request.
service_status (anyOf 1)stringAlternativeWhether Deel can service the job request.
Known values: PENDING, SERVICEABLE, NOT_SERVICEABLE
service_status (anyOf 2)nullAlternative
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeRequested start date.
Format: date-time
start_date (anyOf 2)nullAlternativeRequested start date.
Format: date-time
statusstringOptionalJob request status.
Known values: ACTIVE, PAUSED, CLOSED, NOT_SHARED
titlestringOptionalJob request title.
total_hired_candidatesJSONOptional
total_hired_candidates (anyOf 1)integerAlternativeNumber of candidates hired on this job request.
total_hired_candidates (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_vendorsJSONOptional
total_vendors (anyOf 1)integerAlternativeNumber of talent partners attached to the job request.
total_vendors (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_vendors_per_statusobjectOptionalCount of attached talent partners per status.
Additional keys: see wildcard field
total_vendors_per_status.*JSONAdditional keys
total_vendors_per_status.* (anyOf 1)integerAlternative
total_vendors_per_status.* (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringOptionalWhen the job request was last updated.
Format: date-time
vendorsarrayOptionalTalent partners attached to the job request.
vendors[]ModelEach itemExpand List job requests — talent list Requisitions — 200 response body — data item vendors item
work_modeJSONOptionalWork mode.
work_mode (anyOf 1)stringAlternativeWork mode.
Known values: REMOTE, OFFICE, HYBRID
work_mode (anyOf 2)nullAlternative
yoe_minJSONOptional
yoe_min (anyOf 1)JSONAlternative
yoe_min (anyOf 1) (anyOf 1)integerAlternativeMinimum years of experience required.
yoe_min (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
yoe_min (anyOf 2)nullAlternativeMinimum years of experience required.

Referenced models: List job requests — talent list Requisitions — 200 response body — data item organization, List job requests — talent list Requisitions — 200 response body — data item vendors item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.