OpenProject

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 operations | |:----------------:| --------------------------------------------------------------------------------------------------| ------------- | ----------- | -------------------- | | self | This revision | Revision | not null | READ | | project | The project to which the revision belongs | Project | not null | READ | | author | The user that added this revision, if the authorName was mapped to a user in OpenProject | User | | READ | | showRevision | A URL to the repository view (outside APIv3) showing this revision | - | not null | READ | ## Local Properties | Property | Description | Type | Constraints | Supported operations | |:-----------------------:| ------------------------------------------------------------------------------------------------------------------------------------------------------------| ----------- | ----------- | -------------------- | | id | Revision's id, assigned by OpenProject | Integer | x > 0 | READ | | identifier | The raw SCM identifier of the revision (e.g. full SHA hash) | String | not null | READ | | formattedIdentifier | The SCM identifier of the revision, formatted (e.g. shortened unambiguous SHA hash). May be identical to identifier in many cases | String | not null | READ | | authorName | The name of the author that committed this revision. Note that this name is retrieved from the repository and does not identify a user in OpenProject. | String | not null | READ | | message | The commit message of the revision | Formattable | not null | READ | | createdAt | The time this revision was committed to the repository | DateTime | not null | READ |

GitHub OpenAPI

Operations 1

GET /api/v3/revisions/{id} View revision #

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-revisions-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-revisions-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-revisions-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) Revisions 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: Revisions are sets of updates to files in the context of repositories linked in OpenProject.
  name: Revisions
paths:
  /api/v3/revisions/{id}:
    get:
      parameters:
      - description: Revision id
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _links:
                      author:
                        href: /api/v3/users/1
                      project:
                        href: /api/v3/projects/1
                      self:
                        href: /api/v3/revisions/1
                      showRevision:
                        href: /projects/identifier/repository/revision/11f4b07
                    _type: Revision
                    authorName: Some Developer
                    createdAt: '2015-07-21T13:36:59.454Z'
                    formattedIdentifier: 11f4b07
                    id: 1
                    identifier: 11f4b07dff4f4ce9548a52b7d002daca7cd63ec6
                    message:
                      format: plain
                      html: <p>This revision provides new features<br/><br/>An elaborate description</p>
                      raw: 'This revision provides new features


                        An elaborate description'
              schema:
                $ref: '#/components/schemas/RevisionModel'
          description: OK
          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 specified revision does not exist.
          description: 'Returned if the revision does not exist or the client does not have sufficient permissions

            to see it.


            **Required permission:** view changesets for the project the repository is created in.


            *Note: A client without sufficient permissions shall not be able to test for the existence of a revision.

            That''s why a 404 is returned here, even if a 403 might be more appropriate.*'
          headers: {}
      tags:
      - Revisions
      description: ''
      operationId: View_revision
      summary: View revision
components:
  schemas:
    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
    Formattable:
      type: object
      required:
      - format
      properties:
        format:
          type: string
          enum:
          - plain
          - markdown
          - custom
          readOnly: true
          description: Indicates the formatting language of the raw text
          example: markdown
        raw:
          type: string
          description: The raw text, as entered by the user
          example: I **am** formatted!
        html:
          type: string
          readOnly: true
          description: The text converted to HTML according to the format
          example: I <strong>am</strong> formatted!
      example:
        format: markdown
        raw: I am formatted!
        html: I am formatted!
    RevisionModel:
      type: object
      required:
      - identifier
      - formattedIdentifier
      - authorName
      - message
      - createdAt
      properties:
        id:
          type: integer
          description: Revision's id, assigned by OpenProject
          readOnly: true
          exclusiveMinimum: 0
        identifier:
          type: string
          description: The raw SCM identifier of the revision (e.g. full SHA hash)
          readOnly: true
        formattedIdentifier:
          type: string
          description: The SCM identifier of the revision, formatted (e.g. shortened unambiguous SHA hash). May be identical to identifier in many cases
          readOnly: true
        authorName:
          type: string
          description: The name of the author that committed this revision. Note that this name is retrieved from the repository and does not identify a user in OpenProject.
          readOnly: true
        message:
          allOf:
          - $ref: '#/components/schemas/Formattable'
          - description: The commit message of the revision
            readOnly: true
        createdAt:
          type: string
          format: date-time
          description: The time this revision was committed to the repository
        _links:
          type: object
          required:
          - self
          - project
          - showRevision
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This revision


                  **Resource**: Revision'
                readOnly: true
            project:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The project to which the revision belongs


                  **Resource**: Project'
                readOnly: true
            author:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The user that added this revision, if the authorName was mapped to a user in OpenProject


                  **Resource**: User'
                readOnly: true
            showRevision:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'A URL to the repository view (outside APIv3) showing this revision


                  **Resource**: -'
                readOnly: true
      example:
        _type: Revision
        _links:
          self:
            href: /api/v3/revisions/1
          project:
            href: /api/v3/projects/1
          author:
            href: /api/v3/users/1
          showRevision:
            href: /projects/identifier/repository/revision/11f4b07
        id: 1
        identifier: 11f4b07dff4f4ce9548a52b7d002daca7cd63ec6
        formattedIdentifier: 11f4b07
        authorName: Some Developer
        message:
          format: plain
          raw: 'This revision provides new features


            An elaborate description'
          html: <p>This revision provides new features<br/><br/>An elaborate description</p>
        createdAt: '2015-07-21T13:36:59.859Z'
    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