OpenProject Favorites API
The Favorites API from OpenProject — 2 operation(s) for favorites.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/openproject-favorites-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: You're looking at the current **stable** documentation of the OpenProject APIv3.
title: OpenProject API V3 (Stable) Favorites API
version: '3'
servers:
- url: https://qa.openproject-edge.com
description: Edge QA instance
- url: https://qa.openproject-stage.com
description: Staging instance
- url: https://community.openproject.org
description: Community instance
security:
- BasicAuth: []
tags:
- name: Favorites
paths:
/api/v3/projects/{id}/favorite:
delete:
parameters:
- description: Project id
example: '1'
in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: Returned if the project was successfully removed from favorites.
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the project does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view project'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not authorized to access this resource.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** logged in'
tags:
- Favorites
description: 'Removes the project from the current user''s favorites.
This endpoint is deprecated and replaced by `/api/v3/workspaces/{id}/favorite`'
operationId: Unfavorite_Project
summary: Unfavorite Project
post:
parameters:
- description: Project id
example: '1'
in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: Returned if the project was successfully added to favorites.
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the project does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view project'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not authorized to access this resource.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** logged in'
tags:
- Favorites
description: 'Adds the project to the current user''s favorites.
This endpoint is deprecated and replaced by `/api/v3/workspaces/{id}/favorite`'
operationId: Favorite_Project
summary: Favorite Project
/api/v3/workspaces/{id}/favorite:
delete:
parameters:
- description: Workspace id
example: '1'
in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: Returned if the workspace was successfully removed from favorites.
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the workspace does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view workspace'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not authorized to access this resource.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** logged in'
tags:
- Favorites
description: Removes the workspace from the current user's favorites.
operationId: Unfavorite_Workspace
summary: Unfavorite Workspace
post:
parameters:
- description: Workspace id
example: '1'
in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: Returned if the workspace was successfully added to favorites.
'404':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: 'Returned if the workspace does not exist or the client does not have sufficient permissions
to see it.
**Required permission:** view workspace'
'403':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not authorized to access this resource.
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** logged in'
tags:
- Favorites
description: Adds the workspace to the current user's favorites.
operationId: Favorite_Workspace
summary: Favorite Workspace
components:
schemas:
ErrorResponse:
type: object
required:
- _type
- errorIdentifier
- message
properties:
_embedded:
type: object
properties:
details:
type: object
properties:
attribute:
type: string
example: project
_type:
type: string
enum:
- Error
errorIdentifier:
type: string
example: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
message:
type: string
example: Project can't be blank.
securitySchemes:
BasicAuth:
type: http
scheme: basic