Skip to content

Deel: Apps schemas

5 Deel schemas with complete fields and constraints.

← Apps operations · All schemas

Enable an app — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootAn app that belongs to your organization.
api_accessstringRequired within parentWhether 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
audiencestringRequired within parentWhom the app acts for: `personal` for the user who authorizes it, `organization` for the organization.
Known values: personal, organization
client_typestringRequired within parentWhether the app can keep a secret. `confidential` apps authenticate with a client secret.
Known values: public, confidential
created_atstringRequired within parentTime at which the app was created.
Format: date-time
created_byJSONRequired within parentWho created the app, or null when unknown.
created_by (anyOf 1)ModelAlternativeExpand Enable an app — 200 response body — data / created_by / status: active, left
created_by (anyOf 2)nullAlternative
descriptionstringRequired within parentWhat the app does. Empty when none was set.
idstringRequired within parentUnique identifier of the app.
Format: uuid
logo_urlstringRequired within parentURL of the app logo. Empty when the app has no logo.
namestringRequired within parentName of the app.
redirect_urisarrayRequired within parentURLs Deel may send the user back to after they authorize the app.
redirect_uris[]stringEach item
typestringRequired within parentKind of app. Integration apps connect your organization to Deel.
Known values: integration
updated_atstringRequired within parentTime at which the app was last updated.
Format: date-time
website_urlstringRequired within parentWebsite 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

FieldTypePresenceDescription and constraints
$objectRootWho created the app, or null when unknown.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeName of the person who created the app.
name (anyOf 2)nullAlternativeName of the person who created the app.
statusstringRequired within parentWhether the creator still belongs to your organization (`active`) or no longer does (`left`).
Known values: active, left

List apps — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONRequired within parent
cursor (anyOf 1)stringAlternativeCursor for the next page; pass it as the `cursor` query parameter. Null when there are no more results.
cursor (anyOf 2)nullAlternativeCursor for the next page; pass it as the `cursor` query parameter. Null when there are no more results.
dataarrayRequired within parentThe list of apps.
data[]ModelEach itemExpand Enable an app — 200 response body — data

Referenced models: Enable an app — 200 response body — data

Update an app — request body — body data

FieldTypePresenceDescription and constraints
$objectRootThe fields to change. Send at least one; fields you leave out keep their value.
descriptionstringOptionalNew description of the app.
Maximum length: 200
namestringOptionalNew name of the app.
Maximum length: 150
redirect_urisarrayOptionalNew 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[]stringEach item
website_urlstringOptionalNew website of the app. Must use https.
Format: uri

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.