Other Types

The monday.com portfolio API lets you create portfolio solution boards.

Each object type described below represents a specific part of a portfolio solution. You can use these object types to supply metadata in mutations or to define which fields should be returned in your queries.

ConnectProjectResult

An object containing the result of connecting a portfolio and project board via the API.

FieldDescription
message StringA message describing the result of the operation.
portfolio_item_id StringThe unique identifier of the portfolio item that was created (if successful).
process_id IDA unique process identifier returned when using a callback_url. Use it to correlate the callback response. Available from version 2026-07 and later.
success BooleanWhether the operation was successful.

ConvertBoardToProjectInput

An object containing the board's properties.

FieldDescriptionSupported Subfields
board_id ID!The unique identifier of the board to convert.
callback_url StringThe URL to receive async operation results (optional, but recommended).
column_mappings ColumnsMappingInput!The mapping of project field keys to existing board column IDs.project_owner ID!
project_status ID!
project_timeline ID!

ColumnsMappingInput

An object containing the column mapping properties.

FieldDescription
project_owner ID!The column representing the project's owner.
project_status ID!The column representing the project's status.
project_timeline ID!The column representing the project's timeline or dates.

ConvertBoardToProjectResult

An object containing the result of converting an existing board to a project board via the API.

FieldDescription
message StringA message describing the result of the operation.
process_id StringThe unique identifier that's generated for this process and will be sent to the callback request.
projectId IDThe new project board's unique identifier.
success BooleanWhether the operation was successful.

CreatePortfolioResult

An object containing the result of creating a new portfolio board via the API.

FieldDescription
message StringA message describing the result of the operation.
process_id IDA unique process identifier returned when using a callback_url. The same value is included in the callback payload so you can correlate the initial request with the completion notification. Returns null when no callback_url was provided. Available from version 2026-07 and later.
solution_live_version_id StringThe unique identifier of the solution template that was used to create the portfolio. This is not the portfolio board ID — use the callback_url flow to retrieve the portfolio_id directly, or poll workspace boards.
success BooleanWhether the operation was successful.

CreateProjectInput

🚧

Only available in versions 2026-04 and later

An object containing the new project board's properties.

FieldDescriptionAccepted Values
board_kind BoardKind!The board's privacy setting. Defaults to public.private
public
share
callback_url StringThe callback URL to send the project ID to after asynchronous creation.
companions [String!]A list of companion features to enable. Currently only supports "resource_planner". Can't be used with template_id."resource_planner"
folder_id StringThe unique identifier of the folder to associate with the project. If used with workspace_id, the folder must exist inside the provided workspace.
name String!The board's name.
template_id IDThe unique identifier of the template to create the project from. Currently only supported for solution templates. Can't be used with companions.
workspace_id StringThe unique identifier of the workspace to associate with the project. If omitted, the project will be created in the default workspace.

CreateProjectResult

🚧

Only available in versions 2026-04 and later

An object containing the result of creating a project board via the API.

FieldDescription
error StringAn error message when the request fails.
message StringA message when the request succeeds.
process_id IDA unique process identifier to track the request. Only returned when a callback_url is provided. This ID will be included in the callback payload for correlating the initial request with the completion notification. Returns null if no callback_url was provided.
success BooleanWhether the operation was successful.