Monday Component

Manage boards, tasks and workflows within Monday.

Component key: monday

Description

Monday is a Cloud-based platform that allows companies to create their own applications and work management software. The Monday component allows you to manage columns, items, and subscribers in a Monday board.

Monday offers a GraphQL-based API. This gives you flexibility and control over what data you send to Monday, and what data you request back.

While this component offers some actions that wrap common GraphQL queries and mutations, there are many more queries and mutations for which there aren't dedicated actions. If you'd like to run a query or mutation that is not represented by an action, please use the Generic GraphQL Request action.

Connections

API Key

For testing purposes, you can use an API key to authenticate requests to the Monday GraphQL API. You can configure a Monday Personal API token from your user admin settings. For more information refer to the Monday documentation. We recommend using OAuth when you deploy your integration to customers.

Input	Notes
API Key string / Required apiKey	API Key

OAuth 2.0

To configure OAuth 2.0 you will first need to register a Monday app. Ensure that the Prismatic Callback URL is added to the app in Monday.

Now you will need to add the Monday component's OAuth 2.0 connection to your integration and configure it with:

For Client ID and Client Secret enter the values that you got from your Monday app.
For Scopes refer to Monday's OAuth 2.0 documentation.

Input	Default	Notes	Example
Authorize URL string / Required Hidden Field authorizeUrl	https://auth.monday.com/oauth2/authorize	The OAuth 2.0 Authorization URL for Monday
Client ID string / Required clientId		Client Identifier of your app for Monday
Client Secret password / Required clientSecret		Client Secret of your app for Monday
Scopes string scopes	account:read assets:read boards:read boards:write me:read notifications:write tags:read teams:read updates:read updates:write users:read users:write webhooks:write workspaces:read workspaces:write	Space separated OAuth 2.0 permission scopes for Monday. See https://developer.monday.com/apps/docs/oauth#set-up-permission-scopes.	me:read boards:read
Token URL string / Required Hidden Field tokenUrl	https://auth.monday.com/oauth2/token	The OAuth 2.0 Token URL for Monday

Actions

Archive Board

Delete the information and metadata of a board by Id | key: archiveBoard

Input	Notes	Example
API Version string apiVersion	Provide the version of the API you want to use. If none provided, the default 2024-07 version will be used.	2024-10
Board ID string / Required boardId	Provide the unique identifier of the board
Connection connection / Required connection

Example Payload for Archive Board

{
  "data": {
    "archive_board": {
      "id": "4277545378"
    }
  }
}

Create Board

Create a new board inside your Monday account | key: createBoard

Input	Notes	Example
API Version string apiVersion	Provide the version of the API you want to use. If none provided, the default 2024-07 version will be used.	2024-10
Board Kind string / Required boardKind	Provide a string value for the kind of board.	public
Board Name string / Required boardName	Provide a string value for the name of the board.
Connection connection / Required connection
Folder ID string folderId	Provide the unique identifier of the folder.
Template ID string templateId	Provide the unique identifier of the template that your board extends.
Workspace ID string workspaceId	Provide the unique identifier of the workspace.

Example Payload for Create Board

{
  "data": {
    "create_board": {
      "id": "4277545378"
    }
  }
}

Generic GraphQL Request

Issue any GraphQL query or mutation with variables | key: genericRequest

Input	Notes	Example
API Version string apiVersion	Provide the version of the API you want to use. If none provided, the default 2024-07 version will be used.	2024-10
Connection connection / Required connection
Query or Mutation code / Required query
Variables string Key Value List variables
Variables Object code variablesObject

Get Board

Get the information and metadata of a board by ID | key: getBoard

Input	Notes	Example
API Version string apiVersion	Provide the version of the API you want to use. If none provided, the default 2024-07 version will be used.	2024-10
Board ID string / Required boardId	Provide the unique identifier of the board
Connection connection / Required connection

Example Payload for Get Board

{
  "data": {
    "boards": [
      {
        "id": "2924980809",
        "name": "H2 Kickoff",
        "state": "active",
        "board_folder_id": null,
        "columns": [
          {
            "title": "Name",
            "type": "name"
          },
          {
            "title": "Person",
            "type": "multiple-person"
          },
          {
            "title": "Status",
            "type": "color"
          },
          {
            "title": "Date",
            "type": "date"
          }
        ],
        "creator": {
          "id": 32002207
        }
      }
    ]
  }
}

Get Items By Column Value

Fetch items that have a certain column value. | key: getItemsByColumnValueNew

Input	Notes	Example
API Version string apiVersion	Provide the version of the API you want to use. If none provided, the default 2024-07 version will be used.	2024-10
Board ID string / Required boardId	Provide the unique identifier of the board
Column ID string / Required columnId	Provide the ID of the column. For possible values see https://developer.monday.com/api-reference/reference/column-types-reference#supported-columns.	status
Column Value string / Required columnValue	The column's value to search items by
Connection connection / Required connection
Get All Items boolean getAllItems	If turned off, a maximum of 500 items will be returned.

Example Payload for Get Items By Column Value

{
  "data": {
    "items_by_column_values": [
      {
        "id": "12345678912",
        "name": "task #1",
        "creator": {
          "email": "example@email.com"
        },
        "updated_at": "2024-02-23T15:23:39Z",
        "state": "active",
        "column_values": [
          {
            "id": "person",
            "text": "John Doe",
            "column": {
              "description": null,
              "title": "Person"
            },
            "type": "people",
            "value": "{\"personsAndTeams\":[{\"id\":12345678,\"kind\":\"person\"}]}"
          },
          {
            "id": "status",
            "text": "Working on it",
            "column": {
              "description": null,
              "title": "Status"
            },
            "type": "status",
            "value": "{\"index\":0,\"post_id\":null,\"changed_at\":\"2019-03-01T17:24:57.321Z\"}"
          },
          {
            "id": "date4",
            "text": "2022-07-12",
            "column": {
              "description": null,
              "title": "Date"
            },
            "type": "date",
            "value": "{\"date\":\"2022-07-12\",\"icon\":null,\"changed_at\":\"2022-07-11T20:27:58.362Z\"}"
          },
          {
            "id": "text",
            "text": "This is a text column",
            "column": {
              "description": null,
              "title": "Text"
            },
            "type": "text",
            "value": "\"This is a text column\""
          },
          {
            "id": "country",
            "text": "United States",
            "column": {
              "description": null,
              "title": "Country"
            },
            "type": "country",
            "value": "{\"changed_at\":\"2024-02-23T15:23:39.043Z\",\"countryCode\":\"US\",\"countryName\":\"United States\"}"
          }
        ]
      }
    ]
  }
}

Get Items By Column Value (Deprecated)

Fetch items that have a certain column value. This version of the action is being deprecated. Please replace action with Get Items By Column Value. | key: getItemsByColumnValue

Input	Notes	Example
API Version string apiVersion	Provide the version of the API you want to use. If none provided, the default 2024-07 version will be used.	2024-10
Board ID string / Required boardId	Provide the unique identifier of the board
Column ID string / Required columnId	Provide the ID of the column. For possible values see https://developer.monday.com/api-reference/reference/column-types-reference#supported-columns.	status
Column Value string / Required columnValue	The column's value to search items by
Connection connection / Required connection

Example Payload for Get Items By Column Value (Deprecated)

{
  "data": {
    "items_by_column_values": [
      {
        "id": "4277581981",
        "name": "Task 1",
        "creator": {
          "email": "example@email.com"
        },
        "updated_at": "2023-04-10T16:23:17Z",
        "state": "active",
        "column_values": [
          {
            "id": "numbers",
            "text": "1234",
            "title": "Some Numbers",
            "value": "\"1234\"",
            "description": null,
            "type": "numeric"
          },
          {
            "id": "item_id",
            "text": "4277581981",
            "title": "Item ID",
            "value": null,
            "description": null,
            "type": "pulse-id"
          },
          {
            "id": "text",
            "text": "Hi There",
            "title": "Text",
            "value": "\"Hi There\"",
            "description": null,
            "type": "text"
          }
        ]
      }
    ]
  }
}

List Boards

List all available boards in your Monday account | key: listBoards

Input	Notes	Example
API Version string apiVersion	Provide the version of the API you want to use. If none provided, the default 2024-07 version will be used.	2024-10
Connection connection / Required connection
Result Limit string limit	Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.	20
Page Offset string page	Provide an integer value for the page offset for the given object's results.	3

Example Payload for List Boards

{
  "data": {
    "boards": [
      {
        "id": "2924980809",
        "name": "Example Board",
        "state": "active",
        "board_folder_id": null,
        "creator": {
          "id": 32002207
        }
      }
    ]
  }
}

Manage boards, tasks and workflows within Monday.

Description​

Connections​

API Key​

OAuth 2.0​

Actions​

Archive Board​

Create Board​

Generic GraphQL Request​

Get Board​

Get Items By Column Value​

Get Items By Column Value (Deprecated)​

List Boards​