Skip to content

Deel: List apps

Deel apps.listApps: arguments, response, policy and SDK examples.

← Apps operations · Get started

Operation deel.apps_listapps_v2026_11_04

Provider route: GET /apps. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["apps"]["listApps"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.apps.listApps(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.apps.list_apps(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalMaximum: 100
Minimum: 1
query.cursorstringOptional
query.api_accessstringOptionalOne of: enabled, disabled
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List apps — 200 response body

Referenced models: List apps — 200 response body

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

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

SDK function policy ID: deel.apps_listapps_v2026_11_04. Catalog operation: apps_listapps_v2026_11_04. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["apps:read"]

Pinned headers: {"X-Version": "2026-11-04"}

Official provider source

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.