Deel: List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item

API reference · Contract 2026-10-27

SDK schema: List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item

Field	Type	Presence	Description and constraints
$	object	Root
active	boolean	Optional	Default: false
contractId	string	Optional
contractType	JSON	Optional
contractType (anyOf 1)	string	Alternative
contractType (anyOf 2)	null	Alternative
country	JSON	Optional
country (anyOf 1)	string	Alternative
country (anyOf 2)	null	Alternative
customFields	array	Optional	Contract-level custom fields associated with the employment
customFields[]	Model	Each item	Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item
employeeNumber	JSON	Optional
employeeNumber (anyOf 1)	string	Alternative
employeeNumber (anyOf 2)	null	Alternative
startDate	JSON	Optional
startDate (anyOf 1)	string	Alternative
startDate (anyOf 2)	null	Alternative
state	JSON	Optional
state (anyOf 1)	string	Alternative
state (anyOf 2)	null	Alternative
team	Model	Optional	Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item team
title	JSON	Optional
title (anyOf 1)	string	Alternative
title (anyOf 2)	null	Alternative

Referenced models: List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item, List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item team