Deel: Groups schemas
17 Deel schemas with complete fields and constraints.
← Groups operations · All schemas
Clone a Group — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Clone a Group — 201 response body — data |
Referenced models: Clone a Group — 201 response body — data
Clone a Group — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | The timestamp when the group was created. Format: date-time |
external_metadata | Model | Optional | Expand Clone a Group — 201 response body — data external metadata Extra information of the group. |
id | string | Optional | The unique identifier of the created group. Format: uuid |
name | string | Optional | The name of the created group. |
updated_at | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Extra information of the group. |
Clone a Group — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_metadata | Model | Optional | Expand Clone a Group — request body — body data external metadata The extra information of the group to be created. |
name | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The extra information of the group to be created. |
Create a group — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Create a group — 200 response body — data |
Referenced models: Create a group — 200 response body — data
Create a group — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | The timestamp when the group was created. Format: date-time |
external_metadata | JSON | Optional | Extra information of the group. |
external_metadata (anyOf 1) | Model | Alternative | Expand Clone a Group — 201 response body — data external metadata |
external_metadata (anyOf 2) | null | Alternative | |
id | string | Optional | The unique identifier of the created group. |
name | string | Optional | The name of the created group. |
updated_at | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_metadata | JSON | Optional | The extra information of the group to be created. |
external_metadata (oneOf 1) | Model | Alternative | Expand Clone a Group — request body — body data external metadata |
external_metadata (oneOf 2) | null | Alternative | |
name | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Delete a group — 200 response body — data |
Referenced models: Delete a group — 200 response body — data
Delete a group — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archived_at | string | Optional | The timestamp when the group was archived. Format: date-time |
Edit a group — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Edit a group — 200 response body — data |
Referenced models: Edit a group — 200 response body — data
Edit a group — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | The timestamp when the group was created. Format: date-time |
external_metadata | JSON | Optional | Extra information of the group. |
external_metadata (anyOf 1) | Model | Alternative | Expand Clone a Group — 201 response body — data external metadata |
external_metadata (anyOf 2) | null | Alternative | |
id | string | Optional | The unique identifier of the updated group. |
name | string | Optional | The updated name of the group. |
updated_at | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | The updated name of the group. Maximum length: 48 |
Return list of groups — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand Return list of groups — 200 response body — data item |
page | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archived_at | JSON | Optional | |
archived_at (anyOf 1) | string | Alternative | The timestamp when the group was archived (if applicable). Format: date-time |
archived_at (anyOf 2) | null | Alternative | The timestamp when the group was archived (if applicable). Format: date-time |
created_at | string | Optional | The timestamp when the group was created. Format: date-time |
external_metadata | JSON | Optional | Extra information about the group. |
external_metadata (anyOf 1) | Model | Alternative | Expand Return list of groups — 200 response body — data item external metadata Extra information about the group |
external_metadata (anyOf 2) | null | Alternative | |
id | string | Optional | The unique identifier of the group. |
managers | JSON | Optional | |
managers (anyOf 1) | number | Alternative | The number of managers associated with the group. Format: double |
managers (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | The name of the group. |
status | string | Optional | The current status of the group (active or archived). Known values: active, archived |
updated_at | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Extra information about the group. |
Return list of groups — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cursor | JSON | Optional | |
cursor (anyOf 1) | string | Alternative | An opaque cursor to fetch the next set of results. |
cursor (anyOf 2) | null | Alternative | An opaque cursor to fetch the next set of results. |
total_rows | JSON | Optional | |
total_rows (anyOf 1) | integer | Alternative | The total number of groups available for the current query (including pagination). |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |