OpenProject
OpenProject is an open source project management platform offering work package tracking, Gantt charts, agile boards, time tracking, BIM, and enterprise project portfolio management. The OpenProject APIv3 is a hypermedia (HAL+JSON) REST API that exposes work packages, projects, users, attachments, custom fields, and many other resources.
Real signal across most facets with visible, nameable gaps — the contract exists but is thin, or the portal is good while governance and commercial terms are absent.
API Evangelist profiles OpenProject the way a machine reads it — 70 machine-readable artifacts across 62 APIs, pulled from the provider's own public surface and indexed so a developer, an analyst, or an AI agent can evaluate it against every other provider on the network.
Every provider in the network is reduced to the same set of machine-readable artifacts — OpenAPI contracts, event specifications, GraphQL schemas, runnable collections, pricing and rate-limit signals, security posture, OAuth scopes, and the agent surfaces (MCP servers and skills) that let software drive the API on its own. We profile them because the interface is the part of a company you can actually inspect: it is a truer signal of what a provider does than any marketing page. From those artifacts we compute the Kin Score — OpenProject scores 46.0/100 (developing), with a separate agent-readiness read of 48/100 (agent ready). The full breakdown is below, followed by every artifact we hold — each card links through to its machine-readable definition on apis.io.
Kin Score
This is the API Evangelist rating — a single, repeatable read computed from the artifacts on this page. Green fill is points earned; the red track is points possible, so every bar shows earned-versus-possible at a glance.
How we profile OpenProject
Each block below is one kind of artifact we hold for OpenProject. For each we say what it is and why it earns a place in the profile, then list every one we've indexed — capped at two rows, scroll within the panel for the rest.
APIs 62
Each API is captured as its own OpenAPI definition — every operation, parameter, and response. This is the single most useful machine-readable description of what an API does, and it's what lets us score, lint, mock, and generate against it without asking the provider for anything.
Individual APIs this provider publishes, each with its own machine-readable definition.
OpenProject Actions & Capabilities API
An action is a change one can trigger within the OpenProject instance. This could be creating a work package, exporting work packages or updating a user. An action can also be s...
OpenProject Activities API
## Local Properties | Property | Description | Type | Constraints | Supported operations | | :---------: | ------------- | ---- | ----------- | -------------------- | | id | Act...
OpenProject Attachments API
Attachments are files that were uploaded to OpenProject. Each attachment belongs to a single container (e.g. a work package or a board message). ## Actions | Link | Description ...
OpenProject Budgets API
*Note: Budgets are currently only implemented as a stub. Further properties of budgets might be added at a future date, however they will require the view budget permission to b...
OpenProject Categories API
The categories endpoints return collections or single entities of type `Category`. The following tables list the different properties of `Category` entities. ## Linked Propertie...
OpenProject Collections API
Whenever a client calls a resource that can return more than one element, it will receive a collection of elements. However as collections can become quite large, the API will *...
OpenProject Configuration API
The configuration endpoint allows to read certain configuration parameters of the OpenProject instance. Note that there is no 1:1 relationship between this endpoint and the sett...
OpenProject Custom actions API
Custom actions are a preconfigured set of changes that are applied to a work package. Currently, this resource is a stub. The conditions and changes defined for the custom actio...
OpenProject Custom Field Items API
The Custom Field Items API from OpenProject — 2 operation(s) for custom field items.
OpenProject Custom Fields API
The Custom Fields API from OpenProject — 1 operation(s) for custom fields.
OpenProject Custom Options API
The custom options endpoints return collections or single entities of type `CustomOption`. The following tables list the different properties of `CustomOption` entities. ## Link...
OpenProject Documents API
A document is a file containing a list of attachments. *Please note, that the endpoint is only a stub for now.* ## Actions None yet ## Linked Properties | Link | Description | T...
OpenProject EmojiReactions API
The EmojiReactions API from OpenProject — 2 operation(s) for emojireactions.
OpenProject Favorites API
The Favorites API from OpenProject — 2 operation(s) for favorites.
OpenProject File Links API
The File Links API from OpenProject — 14 operation(s) for file links.
OpenProject Forms API
This API provides forms as a concept to aid in editing or creating resources. The goal of forms is to: * make writable properties of a resource discoverable * show to which valu...
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 th...
OpenProject Groups API
Groups are collections of users. They support assigning/unassigning multiple users to/from a project in one operation. This resource does not yet have the form and schema endpoi...
OpenProject Help texts API
The help texts endpoints return collections or single entities of type `HelpText`. The following tables list the different properties of `HelpText` entities. ## Linked Propertie...
OpenProject Meetings API
The Meetings API from OpenProject — 2 operation(s) for meetings.
OpenProject Memberships API
Users and groups can become members of a project. Such a membership will also have one or more roles assigned to it. By that, memberships control the permissions a user has with...
OpenProject News API
News are articles written by users in order to inform other users of important information. ## Actions | Link | Description | Condition | |:-------------------:|----------------...
OpenProject Notifications API
Notifications are created through notifiable actions in OpenProject. Notifications are triggered by actions carried out in the system by users, e.g. editing a work package, but ...
OpenProject Portfolios API
Portfolios are one of the types of [workspaces](https://www.openproject.org/docs/api/endpoints/workspaces) in OpenProject structuring the information (e.g. work packages, wikis)...
OpenProject Posts API
Represents a post in a board. Posts are also referred to as messages in the application. *This resource is currently a stub* ## Actions | Link | Description | Condition | |:----...
OpenProject Previewing API
Throughout OpenProject user input for many properties can be formatted using *Markdown*. Using the appropriate rendering endpoint it is possible to render custom formatted input...
OpenProject Principals API
Principals are the superclass of users, groups and placeholder users. This endpoint returns all principals within a joined collection but can be filtered to e.g. only return gro...
OpenProject Priorities API
The priorities endpoints return collections or single entities of type `Priority`. The following tables list the different properties of `Priority` entities. ## Linked Propertie...
OpenProject Programs API
Programs are one of the types of [workspaces](https://www.openproject.org/docs/api/endpoints/workspaces) in OpenProject structuring the information (e.g. work packages, wikis) i...
OpenProject Project Phase Definitions API
Project phases separate the whole of the project's duration into smaller, distinct parts. Such a phase will then have different focus on certain aspects of project management. E...
OpenProject Project Phases API
Project phases separate the whole of the project's duration into smaller, distinct parts where each phase has its own start and end date. Such a phase will then have different f...
OpenProject Projects API
Projects are one of the types of [workspaces](https://www.openproject.org/docs/api/endpoints/workspaces) in OpenProject structuring the information (e.g. work packages, wikis) i...
OpenProject Queries API
A query defines how work packages can be filtered and displayed. Clients can define a query once, store it, and use it later on to load the same set of filters and display optio...
OpenProject Query Columns API
A QueryColumn can be referenced by a Query to denote the work package properties the client should display for the work packages returned as query results. The columns maps to t...
OpenProject Query Filter Instance Schema API
A QueryFilterInstanceSchema is a Schema specifically for describing QueryFilterInstances. Because the behaviour of FilterInstances, with regards to the `values` property, differ...
OpenProject Query Filters API
A QueryFilter can be referenced by a filter instance defined for a Query to denote the filtering applied to the query's work package results. This resource is not an instance of...
OpenProject Query Operators API
A QueryOperator can be referenced by a QueryFilter to denote the operator to be applied to the filter relation. ## Actions As of now, no actions are defined. ## Linked Propertie...
OpenProject Query Sort Bys API
A QuerySortBy can be referenced by a Query to denote the sorting applied to the query's work package results. It consists of the columns to sort by as well as the direction (asc...
OpenProject Relations API
Work packages may be related to each other in different ways. ``` +--------------+ +--------------+ | | 1 1 | | | Work package +-------------+--------------+ Work package | | | ...
OpenProject Reminders API
The Reminders API from OpenProject — 3 operation(s) for reminders.
OpenProject Revisions API
Revisions are sets of updates to files in the context of repositories linked in OpenProject. ## Linked Properties | Link | Description | Type | Constraints | Supported operation...
OpenProject Roles API
When principals (groups or users) are assigned to a project, they are receive roles in that project. Roles regulate access to specific resources by having permissions configured...
OpenProject Root API
The root resource contains links to available resources in the API. By following these links a client should be able to discover further resources in the API. *Note: Currently t...
OpenProject Schemas API
The schema provides detailed information about the properties of a resource. The schema is represented by a dictionary where keys are names of resource properties and values are...
OpenProject Sprints API
Work packages can be assigned to a sprint. This is employed in agile contexts such as Scrum or Kanban to group the work packages to be worked on within a defined time frame towa...
OpenProject Statuses API
The statuses endpoints return collections or single entities of type `Status`. The following tables list the different properties of `Status` entities. ## Linked Properties | Li...
OpenProject Time Entries API
The Time Entries API from OpenProject — 6 operation(s) for time entries.
OpenProject Time entry activities API
Time entries are classified by an activity which is one item of a set of user defined activities (e.g. Design, Specification, Development). ## Actions None ## Linked Properties ...
OpenProject Types API
Work package types represented in the system. Types exist globally and are then activated for projects. ## Linked Properties | Link | Description | Type | Constraints | Supporte...
OpenProject User Working Times API
User working times allow configuring per-user working hours and personal non-working days, in addition to the system-wide work schedule. A `UserWorkingHours` record defines how ...
OpenProject UserPreferences API
The user preferences endpoints return collections or single entities of type `UserPreferences`. The following tables list the different properties of `UserPreferences` entities....
OpenProject Users API
The users endpoints return collections or single entities of type `User`. The following tables list the different properties of `User` entities. ## Actions | Link | Description ...
OpenProject Values::Property API
`Values::Property` represents a single key - value pair. That pair typically is an excerpt of the properties of a resource. `Values::Property` itself is not an independent resou...
OpenProject Versions API
Work Packages can be assigned to a version. As such, versions serve to group Work Packages into logical units where each group comprises all the work packages that needs to be f...
OpenProject Views API
A View is a representation of some information. That information might be a query (currently it always is). The view will store the configuration on how to display the informati...
OpenProject Wiki Pages API
Represents an individual page in a project's wiki. *This resource is currently a stub* ## Actions | Link | Description | Condition | |:-------------------:|---------------------...
OpenProject Work Packages API
The work packages endpoints return collections or single entities of type `WorkPackage`. The following tables list the different properties of `WorkPackage` entities. ## Actions...
OpenProject Work Schedule API
The work schedule defines if days are working days or non-working days. A day can be a non-working day if any of these two conditions are met: - the day is a recurring non-worki...
OpenProject WorkPackages API
The WorkPackages API from OpenProject — 1 operation(s) for workpackages.
OpenProject Workspace API
The Workspace API from OpenProject — 1 operation(s) for workspace.
OpenProject Workspaces API
Workspaces are containers for resources to be worked on and people with sets of permissions that work on the former. There is no actual workspace resource in OpenProject. Rather...
Scroll within the panel for all 62 ·
Open Collections 1
Open, tool-agnostic collections carry the same runnable value as Postman without locking you to one client — the portable, forkable form of the same exercise.
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
OpenProject API V3 (Stable)
OPEN COLLECTIONPricing Plans 1
Pricing is part of the interface. Machine-readable plans tell you what a tier costs and includes before you commit — one of the six things the Kin Score reads for commercial clarity.
Published pricing tiers and plan structures.
Rate Limits 1
Rate limits are the difference between a demo that works and a production integration that doesn't fall over. Publishing them is an operational-transparency signal — and a hard requirement for any agent that plans its own throughput.
Documented rate limits and quota policies.
Openproject Rate Limits
RATE LIMITSFinOps 1
Cost, billing, and metering signals let a buyer model the financial operations of an API before it's live. We profile them for the same reason we profile pricing: the money is part of the contract.
Cost, billing, and metering signals for API financial operations.
Openproject Finops
FINOPSSecurity Posture 3
Authentication, domain security, vulnerability disclosure, and trust-center signals — the evidence that a provider takes security seriously enough to document it. We profile it because you can't govern what you can't see.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Agentic Access 1
An x-agentic-access contract marks which operations are safe for an agent to run on its own and which need a human in the loop. It is the difference between an API an agent can use and one it can use safely.
Recommended x-agentic-access execution contracts for AI agents.
Resources
Every other property we hold for OpenProject — documentation, portals, status pages, policies, and corporate surface — grouped by the job it does, following the integrator's arc from getting started to running in production.
Get Started 1
Portal, sign-up, and the first successful call
Documentation 1
Reference material describing how the API behaves
Agent Surfaces 1
MCP servers, agent skills, and machine-readable catalogs
Build 1
SDKs, sample code, and the tooling you integrate with
Access & Security 3
Authentication, authorization, and security posture
Operate 1
Status, limits, changes, and where to get help
Commercial 1
Pricing, plans, and the legal terms of use
Company 3
The organization behind the API
Other 2
Properties that don't map to a standard resource type
← All providers · Data indexed from github.com/api-evangelist/openproject · machine-readable index on apis.io