Skip to content

Deel: Knowledge hub schemas

7 Deel schemas with complete fields and constraints.

← Knowledge hub operations · All schemas

Get Knowledge Hub Country Guides by Country Code — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptionalList of different audiences with associated categories and contract types.
data[]ModelEach itemExpand Get Knowledge Hub Country Guides by Country Code — 200 response body — data item
has_morebooleanOptionalIndicates if there are more items to fetch.
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternativeCursor for the next page of results
next_cursor (anyOf 2)nullAlternativeCursor for the next page of results
total_countJSONOptional
total_count (anyOf 1)numberAlternativeTotal number of audiences
Format: double
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get Knowledge Hub Country Guides by Country Code — 200 response body — data item

Get Knowledge Hub Country Guides by Country Code — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRootRepresents a specific audience such as Contractor, Client, or Employee.
categoriesarrayOptionalList of categories applicable to this audience.
categories[]ModelEach itemExpand Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item
contract_typesarrayOptionalList of contract types available for this audience.
contract_types[]ModelEach itemExpand Get Knowledge Hub Country Guides by Country Code — 200 response body — data item contract types item
namestringRequired within parentDisplay name of the audience.
valuestringRequired within parentIdentifier or key representing the audience in lowercase.

Referenced models: Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item, Get Knowledge Hub Country Guides by Country Code — 200 response body — data item contract types item

Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item

FieldTypePresenceDescription and constraints
$objectRoot
articlesarrayRequired within parentAn array of articles that are connected to this category
articles[]ModelEach itemExpand Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item articles item
fieldsarrayRequired within parentAn array of informative fields and it's value that the category contains
fields[]ModelEach itemExpand Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item fields item
iconstringRequired within parentIcon aligning with the category
idstringRequired within parentID for the category
namestringRequired within parentDisplay name of the category

Referenced models: Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item articles item, Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item fields item

Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item articles item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentThe timestamp when the article was created
Format: date-time
descriptionstringRequired within parentAn excerpt for the article
effective_dateJSONOptional
effective_date (anyOf 1)stringAlternativeThe date when the article will be effective, meaning the content inside it becomes effective in the real world)
Format: date
effective_date (anyOf 2)nullAlternativeThe date when the article will be effective, meaning the content inside it becomes effective in the real world)
Format: date
featured_imagestringRequired within parentThe featured image for the article
Format: uri
idstringRequired within parentID for the article
tagsarrayRequired within parentArray of tags inside an article
tags[]ModelEach itemExpand Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item articles item tags item
titlestringRequired within parentTitle of the article
typestringRequired within parentThe type of the article, can contain knowledge or compliance
Known values: KNOWLEDGE, COMPLIANCE
updated_atstringRequired within parentThe timestamp when the article was last updated
Format: date-time

Referenced models: Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item articles item tags item

Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item articles item tags item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentID for the tag
tagstringRequired within parentSlug for the tag
titlestringRequired within parentTitle of the tag

Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item fields item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentID of the field
namestringRequired within parentTitle of the field
typestringRequired within parentType of the field, can contain text, link or html
Known values: TEXT, LINK, HTML
valueJSONOptional
value (anyOf 1)stringAlternativeThe value associated for the field
value (anyOf 2)nullAlternativeThe value associated for the field

Get Knowledge Hub Country Guides by Country Code — 200 response body — data item contract types item

FieldTypePresenceDescription and constraints
$objectRoot
categoriesarrayRequired within parentList of categories applicable to this audience.
categories[]ModelEach itemExpand Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories item
namestringRequired within parentThe user friendly name of the contract type
valuestringRequired within parentIdentifier or key representing the contract type in lowercase.

Referenced models: Get Knowledge Hub Country Guides by Country Code — 200 response body — data item categories 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.