Learn how to query apps built with the monday.com apps framework
Using the apps framework, you can build apps on top of the monday.com platform. These apps extend the platform's core functionality by bridging gaps and enabling you to customize your workflows.
Apps can be shared directly with select accounts, listed in the app marketplace for all monday.com users, or kept private within the account. They are created and managed in the Developer Center.
Queries
Get app
- Returns an object containing metadata about an app
- Can be queried directly at the root or nested within a
daily_analyticsquery
query {
platform_api {
daily_analytics {
by_app {
app {
name
features {
type
name
}
id
api_app_id
state
}
usage
}
}
}
}import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });
const query = `query ($appId: ID!) { app (id: $appId) { features { id type } } }`;
const variables = {
appId: 1234567890,
};
const response = await mondayApiClient.request(query, variables);Arguments
| Argument | Type | Description |
|---|---|---|
| id | ID! | The app's unique identifier. |
Fields
| Field | Type | Description | Enum Values |
|---|---|---|---|
| account_id | ID | The app's account ID. | |
| api_app_id | ID | The app's unique API consumer identifier. | |
| client_id | String | The app's unique API consumer identifier. | |
| collaborators | [User!] | The app's collaborators. | |
| created_at | Date | The app's creation date. | |
| created_by | ID | The unique identifier of the user who created the app. | |
| description | String | The app's description. | |
| features | [AppFeatureType!] | The app's features. | |
| id | ID! | The app's unique identifier. | |
| kind | String | The app's kind. | |
| name | String | The app's name. | |
| permissions | [String!] | The app's permissions. | |
| photo_url | String | The URL of the app's photo. | |
| photo_url_small | String | The URL of the app's photo in a small size. | |
| slug | String | The app's slug. | |
| state | String | The app's state (active/inactive). | |
| status | AppStatus | The app's status. | DRAFTLIVE |
| updated_at | Date | The date the app was last updated. | |
| user_id | ID | The unique identifier of the user who created the app. | |
| version_type | String | The app's latest version type. | |
| versions | [DeveloperAppVersion!] | The app's versions. Useful for polling the status of a version being promoted. Only available in versions 2026-10 and later. | |
| webhook_url | String | The app's webhook endpoint URL. |
Mutations
Create app
Creates a new app. Returns App.
mutation {
create_app(
input: {
collaborators: [54321, 12345],
description: "The updated app description.",
name: "The updated app name.",
kind: PUBLIC,
permissions: ["docs:write", "me:read"]
}
) {
description
name
kind
permissions
collaborators {
id
}
}
}Arguments
| Argument | Type | Description |
|---|---|---|
| input | CreateAppInput! | An object containing the new app's configuration data. |
Update app
Updates an app. Returns App.
🚧 Only works for app collaborators
mutation {
update_app(
id: 123456,
input: {
collaborators: [54321, 12345],
description: "The updated app description.",
name: "The updated app name."
}
) {
description
name
collaborators {
id
}
}
} Arguments
| Argument | Type | Description |
|---|---|---|
| id | ID! | The unique identifier of the app to update. |
| input | UpdateAppInput! | An object containing the updated app's configuration data. |
Promote app
Only available in API versions
2026-10and later
Initiates promotion of a draft app version to live. This is an asynchronous operation — promotion may take several seconds to complete. Returns a DeveloperAppVersion object that you can use to poll the promotion status.
To track when promotion is complete, poll the app query and check versions[].status until it changes from PROMOTING to LIVE.
NOTEOnly app collaborators can run this mutation.
mutation {
promote_app(
app_id: "1234567890"
) {
id
status
}
}# Poll app versions after promoting
query {
app(id: "1234567890") {
id
name
versions {
id
status
}
}
}Arguments
| Argument | Type | Description |
|---|---|---|
| app_id | ID! | The unique identifier of the app to promote. |
| app_version_id | ID | The ID of the specific draft version to promote. If omitted, the latest draft version is promoted. |
