Deel: Apps schemas
5 Deel schemas with complete fields and constraints.
← Apps operations · All schemas
Enable an app — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Enable an app — 200 response body — data An app that belongs to your organization. |
Referenced models: Enable an app — 200 response body — data
Enable an app — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An app that belongs to your organization. |
api_access | string | Required within parent | Whether API access is switched on for the app: `disabled` after the app is disabled, by you or by Deel, until it is enabled again. Known values: enabled, disabled |
audience | string | Required within parent | Whom the app acts for: `personal` for the user who authorizes it, `organization` for the organization. Known values: personal, organization |
client_type | string | Required within parent | Whether the app can keep a secret. `confidential` apps authenticate with a client secret. Known values: public, confidential |
created_at | string | Required within parent | Time at which the app was created. Format: date-time |
created_by | JSON | Required within parent | Who created the app, or null when unknown. |
created_by (anyOf 1) | Model | Alternative | Expand Enable an app — 200 response body — data / created_by / status: active, left |
created_by (anyOf 2) | null | Alternative | |
description | string | Required within parent | What the app does. Empty when none was set. |
id | string | Required within parent | Unique identifier of the app. Format: uuid |
logo_url | string | Required within parent | URL of the app logo. Empty when the app has no logo. |
name | string | Required within parent | Name of the app. |
redirect_uris | array | Required within parent | URLs Deel may send the user back to after they authorize the app. |
redirect_uris[] | string | Each item | |
type | string | Required within parent | Kind of app. Integration apps connect your organization to Deel. Known values: integration |
updated_at | string | Required within parent | Time at which the app was last updated. Format: date-time |
website_url | string | Required within parent | Website of the app. Empty when none was set. |
Referenced models: Enable an app — 200 response body — data / created_by / status: active, left
Enable an app — 200 response body — data / created_by / status: active, left
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Who created the app, or null when unknown. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Name of the person who created the app. |
name (anyOf 2) | null | Alternative | Name of the person who created the app. |
status | string | Required within parent | Whether the creator still belongs to your organization (`active`) or no longer does (`left`). Known values: active, left |
List apps — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cursor | JSON | Required within parent | |
cursor (anyOf 1) | string | Alternative | Cursor for the next page; pass it as the `cursor` query parameter. Null when there are no more results. |
cursor (anyOf 2) | null | Alternative | Cursor for the next page; pass it as the `cursor` query parameter. Null when there are no more results. |
data | array | Required within parent | The list of apps. |
data[] | Model | Each item | Expand Enable an app — 200 response body — data |
Referenced models: Enable an app — 200 response body — data
Update an app — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The fields to change. Send at least one; fields you leave out keep their value. |
description | string | Optional | New description of the app. Maximum length: 200 |
name | string | Optional | New name of the app. Maximum length: 150 |
redirect_uris | array | Optional | New list of redirect URLs. It replaces the current list. At most 10, no duplicates, https only (http is accepted for 127.0.0.1 and [::1] outside production). |
redirect_uris[] | string | Each item | |
website_url | string | Optional | New website of the app. Must use https. Format: uri |