Skip to content

Deel: ATS tags schemas

2 Deel schemas with complete fields and constraints.

← ATS tags operations · All schemas

List candidate tags of the organization — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of tags.
data[]ModelEach itemExpand List candidate tags of the organization — 200 response body — data item
has_morebooleanRequired within parentWhether more results exist (pagination).
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page of results, or null if none.
Maximum length: 1000
next_cursor (anyOf 2)nullAlternativeCursor for the next page of results, or null if none.
Maximum length: 1000
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of tags returned.
Minimum: 0
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List candidate tags of the organization — 200 response body — data item

List candidate tags of the organization — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeWhen the tag was archived; null while the tag is active and selectable.
Format: date-time
archived_at (anyOf 2)nullAlternativeWhen the tag was archived; null while the tag is active and selectable.
Format: date-time
candidates_countJSONOptional
candidates_count (anyOf 1)JSONAlternative
candidates_count (anyOf 1) (anyOf 1)integerAlternativeNumber of candidates with this tag. Present only when include_counts=true.
candidates_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
candidates_count (anyOf 2)nullAlternativeNumber of candidates with this tag. Present only when include_counts=true.
created_atstringRequired within parentWhen the tag was created.
Format: date-time
created_by_hris_organization_user_idJSONOptional
created_by_hris_organization_user_id (anyOf 1)stringAlternativeID of the user who created the tag, if any.
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeID of the user who created the tag, if any.
Format: uuid
idstringRequired within parentUnique identifier of the tag.
Format: uuid
labelstringOptionalDisplay name of the tag.
tag_group_slugstringOptionalTag group. Use CANDIDATE for candidate tags.
Known values: CANDIDATE
updated_atstringRequired within parentWhen the tag was last updated.
Format: date-time
updated_by_hris_organization_user_idJSONOptional
updated_by_hris_organization_user_id (anyOf 1)stringAlternativeID of the user who last updated the tag, if any.
Format: uuid
updated_by_hris_organization_user_id (anyOf 2)nullAlternativeID of the user who last updated the tag, if any.
Format: uuid

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.