Skip to content

Deel: Groups schemas

17 Deel schemas with complete fields and constraints.

← Groups operations · All schemas

Clone a Group — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Clone a Group — 201 response body — data

Referenced models: Clone a Group — 201 response body — data

Clone a Group — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalThe timestamp when the group was created.
Format: date-time
external_metadataModelOptionalExpand Clone a Group — 201 response body — data external metadata
Extra information of the group.
idstringOptionalThe unique identifier of the created group.
Format: uuid
namestringOptionalThe name of the created group.
updated_atstringOptionalThe timestamp when the group was last updated.
Format: date-time

Referenced models: Clone a Group — 201 response body — data external metadata

Clone a Group — 201 response body — data external metadata

FieldTypePresenceDescription and constraints
$objectRootExtra information of the group.

Clone a Group — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
external_metadataModelOptionalExpand Clone a Group — request body — body data external metadata
The extra information of the group to be created.
namestringRequired within parentThe name of the group to be created.
Maximum length: 48

Referenced models: Clone a Group — request body — body data external metadata

Clone a Group — request body — body data external metadata

FieldTypePresenceDescription and constraints
$objectRootThe extra information of the group to be created.

Create a group — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Create a group — 200 response body — data

Referenced models: Create a group — 200 response body — data

Create a group — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalThe timestamp when the group was created.
Format: date-time
external_metadataJSONOptionalExtra information of the group.
external_metadata (anyOf 1)ModelAlternativeExpand Clone a Group — 201 response body — data external metadata
external_metadata (anyOf 2)nullAlternative
idstringOptionalThe unique identifier of the created group.
namestringOptionalThe name of the created group.
updated_atstringOptionalThe timestamp when the group was last updated.
Format: date-time

Referenced models: Clone a Group — 201 response body — data external metadata

Create a group — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
external_metadataJSONOptionalThe extra information of the group to be created.
external_metadata (oneOf 1)ModelAlternativeExpand Clone a Group — request body — body data external metadata
external_metadata (oneOf 2)nullAlternative
namestringRequired within parentThe name of the group to be created.
Maximum length: 48

Referenced models: Clone a Group — request body — body data external metadata

Delete a group — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Delete a group — 200 response body — data

Referenced models: Delete a group — 200 response body — data

Delete a group — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
archived_atstringOptionalThe timestamp when the group was archived.
Format: date-time

Edit a group — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Edit a group — 200 response body — data

Referenced models: Edit a group — 200 response body — data

Edit a group — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalThe timestamp when the group was created.
Format: date-time
external_metadataJSONOptionalExtra information of the group.
external_metadata (anyOf 1)ModelAlternativeExpand Clone a Group — 201 response body — data external metadata
external_metadata (anyOf 2)nullAlternative
idstringOptionalThe unique identifier of the updated group.
namestringOptionalThe updated name of the group.
updated_atstringOptionalThe timestamp when the group was last updated.
Format: date-time

Referenced models: Clone a Group — 201 response body — data external metadata

Edit a group — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentThe updated name of the group.
Maximum length: 48

Return list of groups — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Return list of groups — 200 response body — data item
pageModelOptionalExpand Return list of groups — 200 response body — page

Referenced models: Return list of groups — 200 response body — data item, Return list of groups — 200 response body — page

Return list of groups — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeThe timestamp when the group was archived (if applicable).
Format: date-time
archived_at (anyOf 2)nullAlternativeThe timestamp when the group was archived (if applicable).
Format: date-time
created_atstringOptionalThe timestamp when the group was created.
Format: date-time
external_metadataJSONOptionalExtra information about the group.
external_metadata (anyOf 1)ModelAlternativeExpand Return list of groups — 200 response body — data item external metadata Extra information about the group
external_metadata (anyOf 2)nullAlternative
idstringOptionalThe unique identifier of the group.
managersJSONOptional
managers (anyOf 1)numberAlternativeThe number of managers associated with the group.
Format: double
managers (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalThe name of the group.
statusstringOptionalThe current status of the group (active or archived).
Known values: active, archived
updated_atstringOptionalThe timestamp when the group was last updated.
Format: date-time

Referenced models: Return list of groups — 200 response body — data item external metadata Extra information about the group

Return list of groups — 200 response body — data item external metadata Extra information about the group

FieldTypePresenceDescription and constraints
$objectRootExtra information about the group.

Return list of groups — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONOptional
cursor (anyOf 1)stringAlternativeAn opaque cursor to fetch the next set of results.
cursor (anyOf 2)nullAlternativeAn opaque cursor to fetch the next set of results.
total_rowsJSONOptional
total_rows (anyOf 1)integerAlternativeThe total number of groups available for the current query (including pagination).
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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.