OpenProject

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 for them. Currently, this is only a stub. ## Linked Properties | Link | Description | Type | Constraints | Supported operations | | :-------------------: | ----------------------------------------- | ------------- | -------------------------------| -------------------- | | self | This role | Role | not null | READ | ## Local Properties | Property | Description | Type | Constraints | Supported operations | | :---------: | --------------------------------------------- | ----------- | ----------- | -------------------- | | id | Role id | Integer | x > 0 | READ | | name | Role name | String | not null | READ |

GitHub OpenAPI

Operations 2

GET /api/v3/roles List roles #
GET /api/v3/roles/{id} View role #

Documentation

📖
Documentation
https://www.openproject.org/docs/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-roles-api-openapi.yml

Other Resources

🔗
Introduction
https://www.openproject.org/docs/api/introduction/
🔗
Endpoints
https://www.openproject.org/docs/api/endpoints/
🔗
GitHub
https://github.com/opf/openproject

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/openproject:openproject-roles-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openproject-roles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: You're looking at the current **stable** documentation of the OpenProject APIv3.
  title: OpenProject API V3 (Stable) Roles 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:
- description: When principals (groups or users) are assigned to a project, they are receive roles in that project.
  name: Roles
paths:
  /api/v3/roles:
    get:
      parameters:
      - description: 'JSON specifying filter conditions.

          Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.

          Currently supported filters are:


          + grantable: filters roles based on whether they are selectable for a membership


          + unit: filters roles based on the unit (''project'' or ''system'') for which they are selectable for a membership'
        example: '[{ "unit": { "operator": "=", "values": ["system"] }" }]'
        in: query
        name: filters
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _embedded:
                      elements:
                      - _links:
                          self:
                            href: /api/v3/roles/3
                            title: Manager
                        _type: Role
                        id: 3
                        name: Manager
                      - _links:
                          self:
                            href: /api/v3/roles/2
                            title: Anonymous
                        _type: Role
                        id: 2
                        name: Anonymous
                      - _links:
                          self:
                            href: /api/v3/roles/5
                            title: Reader
                        _type: Role
                        id: 5
                        name: Reader
                      - _links:
                          self:
                            href: /api/v3/roles/4
                            title: Member
                        _type: Role
                        id: 4
                        name: Member
                      - _links:
                          self:
                            href: /api/v3/roles/1
                            title: Non member
                        _type: Role
                        id: 1
                        name: Non member
                    _links:
                      self:
                        href: /api/v3/roles
                    _type: Collection
                    count: 5
                    total: 5
              schema:
                $ref: '#/components/schemas/RolesModel'
          description: OK
          headers: {}
      tags:
      - Roles
      description: List all defined roles. This includes built in roles like 'Anonymous' and 'Non member'.
      operationId: List_roles
      summary: List roles
  /api/v3/roles/{id}:
    get:
      parameters:
      - description: Role id
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _links:
                      self:
                        href: /api/v3/roles/3
                        title: Manager
                    _type: Role
                    id: 3
                    name: Manager
              schema:
                $ref: '#/components/schemas/RoleModel'
          description: OK
          headers: {}
        '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 view this resource.
          description: 'Returned if the client does not have sufficient permissions to see roles.


            **Required permission:** view members **or** manage members'
          headers: {}
        '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 role does not exist.
          headers: {}
      tags:
      - Roles
      description: Fetch an individual role.
      operationId: View_role
      summary: View role
components:
  schemas:
    RoleModel:
      type: object
      required:
      - name
      properties:
        _type:
          type: string
          enum:
          - Role
        id:
          type: integer
          description: Role id
          readOnly: true
          minimum: 1
        name:
          type: string
          description: Role name
        _links:
          type: object
          required:
          - self
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This role


                  **Resource**: Role'
                readOnly: true
      example:
        _type: Role
        id: 3
        name: Manager
        _links:
          self:
            href: /api/v3/roles/3
            title: Manager
    Link:
      type: object
      required:
      - href
      properties:
        href:
          type:
          - string
          - 'null'
          description: URL to the referenced resource (might be relative)
        title:
          type: string
          description: Representative label for the resource
        templated:
          type: boolean
          default: false
          description: If true the href contains parts that need to be replaced by the client
        method:
          type: string
          default: GET
          description: The HTTP verb to use when requesting the resource
        payload:
          type: object
          description: The payload to send in the request to achieve the desired result
        identifier:
          type: string
          description: An optional unique identifier to the link object
        type:
          type: string
          description: The MIME-Type of the returned resource.
      example:
        href: /api/v3/work_packages
        method: POST
    RolesModel:
      type: object
      example:
        _type: Collection
        total: 5
        count: 5
        _embedded:
          elements:
          - _type: Role
            id: 3
            name: Manager
            _links:
              self:
                href: /api/v3/roles/3
                title: Manager
          - _type: Role
            id: 2
            name: Anonymous
            _links:
              self:
                href: /api/v3/roles/2
                title: Anonymous
          - _type: Role
            id: 5
            name: Reader
            _links:
              self:
                href: /api/v3/roles/5
                title: Reader
          - _type: Role
            id: 4
            name: Member
            _links:
              self:
                href: /api/v3/roles/4
                title: Member
          - _type: Role
            id: 1
            name: Non member
            _links:
              self:
                href: /api/v3/roles/1
                title: Non member
        _links:
          self:
            href: /api/v3/roles
    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