How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenProject Grids API

A grid is a layout for a page or a part of the page of the OpenProject application. It defines the structure (number of rows and number of columns) as well as the contents of the page.The contents is defined by `GridWidget`s. While a `GridWidget` is its own type, it is not a resource in its own right as it is an intrinsic part of a `Grid`.Depending on what page a grid is defined for, different widgets may be eligible to be placed on the grid. The page might also define the permissions needed for accessing, creating or modifying the grid.Currently, the following pages employ grids:+ /my/page: The My page every user has. Only a user can access or modify their "My page".*The delete action is not yet supported*## Actions| Link | Description | Condition ||:-------------------:| -------------------------------------------------------------------- | ---------------------------------------------------------------- || updateImmediately | Directly perform edits on this grid | **Permission**: depends on the page the grid is defined for || update | Validate edits on the grid via a form resource before committing | **Permission**: depends on the page the grid is defined for |## Linked Properties| Link | Description | Type | Constraints | Supported operations | Condition || :-----------: | -------------------------------------------------------------- | ------------- | --------------------- | -------------------- | ----------------------------------------- || self | This grid | Grid | not null | READ | || page | The url of the page the grid is defined for | url | not null | READ / WRITE | The page cannot be changed after the creation |## Local Properties| Property | Description | Type | Constraints | Supported operations | Condition || :----------: | --------------------------------------------------------- | -------- | ---------------------------------------------------- | -------------------- | -------------- || id | Grid's id | Integer | x > 0 | READ | || rowCount | The number of rows the grid has | Integer | x > 0 | READ/WRITE | || columnCount | The number of columns the grid has | Integer | x > 0 | READ/WRITE | || widgets | The set of `GridWidget`s selected for the grid | []GridWidget | | READ/WRITE | The widgets cannot overlap || createdAt | The time the grid was created | DateTime | | READ |   || updatedAt | The time the grid was last updated | DateTime | | READ |   |## GridWidget Properties| Property | Description | Type | Constraints | Supported operations | Condition || :----------: | --------------------------------------------------------- | -------- | ---------------------------------------------------- | -------------------- | -------------- || identifier | The kind of widget | String | not null | READ/WRITE | || startRow | The row the widget starts at (1 based) | Integer | x > 0, x 0, x startRow | READ/WRITE | || startColumn | The column the widget starts at (1 based) | Integer | x > 0, x 0, x startColumn | READ/WRITE | || options | An options hash of values customizable by the widget | JSON | | READ/WRITE | |

OpenProject Grids API is one of 62 APIs that OpenProject publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Grids. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.1.2, at version 3.

Requests are made against 3 base URLs: https://qa.openproject-edge.com, https://qa.openproject-stage.com, https://community.openproject.org.

6 operations 4 paths 9 schemas 2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.2
API Version
3
Base URL
https://community.openproject.org/api/v3
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

OpenProject Grids API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Grids 6

A grid is a layout for a page or a part of the page of the OpenProject application. It defines the structure (number of rows and number of columns) as well as the contents of the…

GET
/api/v3/grids
List grids
list_grids 3 params → 200400403
POST
/api/v3/grids
Create a grid
create_grid body → 201400403406415422
POST
/api/v3/grids/form
Grid Create Form
Grid_Create_Form → 200
GET
/api/v3/grids/{id}
Get a grid
get_grid 1 param → 200404
PATCH
/api/v3/grids/{id}
Update a grid
update_grid 1 param body → 200400403406415422
POST
/api/v3/grids/{id}/form
Grid Update Form
Grid_Update_Form 1 param → 200403404406415

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are GridReadModel (8 properties), GridWidgetModel (8 properties), Link (7 properties), ErrorResponse (4 properties). Each schema is shown below with its type and property counts.

CollectionModel
object
4 properties 4 required
GridWriteModel
object
4 properties
CollectionLinks
object
1 property 1 required
GridWidgetModel
object
8 properties 7 required
Link
object
7 properties 1 required
GridReadModel
object
8 properties 6 required
PaginatedCollectionModel
ErrorResponse
object
4 properties 3 required
GridCollectionModel

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openproject-grids-api-openapi.yml Raw ↑

Other APIs OpenProject publishes across the network.

OpenProject Actions & Capabilities API
OpenProject Activities API
OpenProject Attachments API
OpenProject Budgets API
OpenProject Categories API
OpenProject Collections API
OpenProject Configuration API
OpenProject Custom actions API
OpenProject Custom Field Items API
OpenProject Custom Fields API
OpenProject Custom Options API
OpenProject Documents API
Where this information came from

This is an independent, third-party profile of OpenProject Grids API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.