### Retrieve Project Document Folders API Source: https://capmoapi.readme.io/reference/getprojectdocumentfolders This endpoint allows listing all project document folders in a paginated response. It provides an example of a GET request to retrieve folder information. ```APIDOC GET /api/v1/projects/{projectId}/document-folders Description: This endpoint lists all project document folders in a paginated response. Full URL: https://api.capmo.de/api/v1/projects/{projectId}/document-folders Supported Languages for Examples: Shell, Node, Ruby, PHP, Python ``` -------------------------------- ### Project Plans API Endpoints Source: https://capmoapi.readme.io/reference/where-to-start API endpoints for managing plan folders within specific projects, including listing, creating, and updating plan folder details. ```APIDOC GET /api/v1/projects/{projectId}/plan-folders - Retrieves a list of plan folders for a specific project. POST /api/v1/projects/{projectId}/plan-folders - Creates a new plan folder within a project. PATCH /api/v1/projects/{projectId}/plan-folders/{folderId} - Updates details for a specific plan folder by ID. ``` -------------------------------- ### Capmo Utility API Endpoints Source: https://capmoapi.readme.io/reference/createprojectticketattachment Miscellaneous utility API endpoints. ```APIDOC GET /api/v1/validate - Validates API access or status. ``` -------------------------------- ### Delete Project Document File API Example Source: https://capmoapi.readme.io/reference/deleteprojectdocument Detailed example for deleting a specific document file within a Capmo project. This endpoint supports various programming languages for integration. ```APIDOC DELETE /api/v1/projects/{projectId}/document-files/{fileId} URL: https://api.capmo.de/api/v1/projects/{projectId}/document-files/{fileId} Credentials: Header authentication required. Supported Languages: Shell, Node, Ruby, PHP, Python Response: Click 'Try It!' to start a request and see the response here! ``` -------------------------------- ### Initiate File Uploads API Source: https://capmoapi.readme.io/reference/getprojecttemplates API endpoints for initiating file uploads for various project assets like documents, plans, and ticket attachments. ```APIDOC POST /api/v1/upload/projects/{projectId}/document-files POST /api/v1/upload/plans POST /api/v1/upload/ticket-attachments ``` -------------------------------- ### Capmo API: Project Document and Folder Management Source: https://capmoapi.readme.io/index Endpoints for managing documents and folders within projects. This includes operations for creating, retrieving, renaming, and deleting document files, as well as managing document folders (get, create, get by ID, rename, delete). ```APIDOC POST /api/v1/projects/{projectId}/document-files GET /api/v1/projects/{projectId}/document-files GET /api/v1/projects/{projectId}/document-files/{fileId} PATCH /api/v1/projects/{projectId}/document-files/{fileId} DELETE /api/v1/projects/{projectId}/document-files/{fileId} GET /api/v1/projects/{projectId}/document-folders POST /api/v1/projects/{projectId}/document-folders GET /api/v1/projects/{projectId}/document-folders/{folderId} PATCH /api/v1/projects/{projectId}/document-folders/{folderId} DELETE /api/v1/projects/{projectId}/document-folders/{folderId} ``` -------------------------------- ### Capmo API: Organisation Memberships Endpoints Source: https://capmoapi.readme.io/reference/createorganisationcompany Manages memberships within an organisation, including retrieving, inviting, getting details, updating, and revoking memberships. ```APIDOC GET /api/v1/organisation/membershipsget POST /api/v1/organisation/membershipspost GET /api/v1/organisation/memberships/{membershipId}get PATCH /api/v1/organisation/memberships/{membershipId}patch DELETE /api/v1/organisation/memberships/{membershipId}delete ``` -------------------------------- ### Projects API Endpoints Source: https://capmoapi.readme.io/reference/where-to-start API endpoints for managing projects, including listing all projects, creating new ones, and performing operations on individual project records. ```APIDOC GET /api/v1/projects - Retrieves a list of projects. POST /api/v1/projects - Creates a new project. GET /api/v1/projects/{projectId} - Retrieves details for a specific project by ID. PATCH /api/v1/projects/{projectId} - Updates details for a specific project by ID. DELETE /api/v1/projects/{projectId} - Deletes a specific project by ID. ``` -------------------------------- ### Capmo API: Organisation Memberships Endpoints Source: https://capmoapi.readme.io/reference/getprojectmemberships Endpoints for managing memberships within an organisation, including retrieving, inviting, getting details, updating, and revoking memberships. ```APIDOC GET /api/v1/organisation/memberships - Retrieves a list of all memberships in the organisation. POST /api/v1/organisation/memberships - Invites a new person to the organisation, creating a membership. GET /api/v1/organisation/memberships/{membershipId} - Retrieves details for a specific membership by ID. - Parameters: - membershipId: The unique identifier of the membership. PATCH /api/v1/organisation/memberships/{membershipId} - Updates an existing membership record by ID. - Parameters: - membershipId: The unique identifier of the membership. DELETE /api/v1/organisation/memberships/{membershipId} - Revokes a membership by ID. - Parameters: - membershipId: The unique identifier of the membership. ``` -------------------------------- ### Capmo Project Plans and Folders API Source: https://capmoapi.readme.io/reference/createprojectcompanyfromorganisation Endpoints for managing project plans and their associated folders, including creation, retrieval, updates, and deletion. ```APIDOC DELETE /api/v1/projects/{projectId}/plan-folders/{folderId} - Deletes a specific plan folder. ``` ```APIDOC POST /api/v1/projects/{projectId}/plans - Creates a new project plan. ``` ```APIDOC GET /api/v1/projects/{projectId}/plans - Retrieves a list of all project plans. ``` ```APIDOC GET /api/v1/projects/{projectId}/plans/{planId} - Retrieves details for a specific project plan. ``` ```APIDOC DELETE /api/v1/projects/{projectId}/plans/{planId} - Deletes a specific project plan. ``` ```APIDOC PATCH /api/v1/projects/{projectId}/plans/{planId} - Updates details for a specific project plan. ``` -------------------------------- ### Manage Project Plans and Folders API Source: https://capmoapi.readme.io/reference/createprojectcompany This section outlines API endpoints for managing project plans and their associated folders, allowing for creation, retrieval, updates, and deletion of plan-related data. ```APIDOC DELETE /api/v1/projects/{projectId}/plan-folders/{folderId} POST /api/v1/projects/{projectId}/plans GET /api/v1/projects/{projectId}/plans GET /api/v1/projects/{projectId}/plans/{planId} DELETE /api/v1/projects/{projectId}/plans/{planId} PATCH /api/v1/projects/{projectId}/plans/{planId} ``` -------------------------------- ### Capmo API: Project Memberships Endpoints Source: https://capmoapi.readme.io/reference/getprojectmemberships Endpoints for managing memberships within specific projects, including retrieving, inviting, getting details, and revoking project memberships. ```APIDOC GET /api/v1/projects/{projectId}/memberships - Retrieves a list of all memberships within a specific project. - Parameters: - projectId: The unique identifier of the project. POST /api/v1/projects/{projectId}/memberships - Invites a new person to a project, creating a project membership. - Parameters: - projectId: The unique identifier of the project. GET /api/v1/projects/{projectId}/memberships/{membershipId} - Retrieves details for a specific project membership by ID. - Parameters: - projectId: The unique identifier of the project. - membershipId: The unique identifier of the membership. DELETE /api/v1/projects/{projectId}/memberships/{membershipId} - Revokes a project membership by ID. - Parameters: - projectId: The unique identifier of the project. - membershipId: The unique identifier of the membership. ``` -------------------------------- ### Manage Project Plans and Folders API Source: https://capmoapi.readme.io/reference/createsitejournal Endpoints for creating, retrieving, updating, and deleting project plans and their associated folders within the Capmo platform. ```APIDOC DELETE /api/v1/projects/{projectId}/plan-folders/{folderId} - Deletes a specific plan folder. POST /api/v1/projects/{projectId}/plans - Creates a new project plan. GET /api/v1/projects/{projectId}/plans - Retrieves a list of project plans. GET /api/v1/projects/{projectId}/plans/{planId} - Retrieves details for a specific project plan. DELETE /api/v1/projects/{projectId}/plans/{planId} - Deletes a specific project plan. PATCH /api/v1/projects/{projectId}/plans/{planId} - Updates details for a specific project plan. ``` -------------------------------- ### Capmo REST API: Organisation Memberships Endpoints Source: https://capmoapi.readme.io/reference/deleteplan Endpoints for managing memberships within an organisation, including retrieving, inviting, getting details, updating, and revoking memberships. ```APIDOC GET /api/v1/organisation/memberships POST /api/v1/organisation/memberships GET /api/v1/organisation/memberships/{membershipId} PATCH /api/v1/organisation/memberships/{membershipId} DELETE /api/v1/organisation/memberships/{membershipId} ``` -------------------------------- ### Capmo REST API: Project Memberships Endpoints Source: https://capmoapi.readme.io/reference/deleteplan Endpoints for managing memberships within specific projects, including retrieving, inviting, getting details, and revoking project memberships. ```APIDOC GET /api/v1/projects/{projectId}/memberships POST /api/v1/projects/{projectId}/memberships GET /api/v1/projects/{projectId}/memberships/{membershipId} DELETE /api/v1/projects/{projectId}/memberships/{membershipId} ``` -------------------------------- ### Capmo API: Project Templates Endpoints Source: https://capmoapi.readme.io/reference/createproject This section describes the API endpoints for interacting with project templates. It enables users to retrieve lists of available templates or fetch details for a specific template by its identifier. ```APIDOC GET /api/v1/project-templates - Retrieve all available project templates. GET /api/v1/project-templates/{projectTemplateId} - Retrieve a specific project template by its ID. ``` -------------------------------- ### Capmo API: Projects Endpoints Source: https://capmoapi.readme.io/reference/getprojects Endpoints for managing projects, including listing all projects, creating new projects, and performing detailed operations (GET, PATCH, DELETE) on individual projects by ID. ```APIDOC GET /api/v1/projects POST /api/v1/projects GET /api/v1/projects/{projectId} PATCH /api/v1/projects/{projectId} DELETE /api/v1/projects/{projectId} ``` -------------------------------- ### Capmo API: Project Plans Endpoints Source: https://capmoapi.readme.io/reference/createproject This section describes the API endpoints for managing plan folders within projects. It supports operations to retrieve, create, and update plan folders. ```APIDOC GET /api/v1/projects/{projectId}/plan-folders - Retrieve all plan folders for a specific project. POST /api/v1/projects/{projectId}/plan-folders - Create a new plan folder within a specific project. PATCH /api/v1/projects/{projectId}/plan-folders/{folderId} - Update the details of a specific plan folder by its ID within a project. ``` -------------------------------- ### Capmo API: Projects Endpoints Source: https://capmoapi.readme.io/reference/deleteprojectticket API endpoints for managing projects, allowing for retrieval of all projects, creation of new projects, and specific operations (GET, PATCH, DELETE) on individual project IDs. ```APIDOC GET /api/v1/projects POST /api/v1/projects GET /api/v1/projects/{projectId} PATCH /api/v1/projects/{projectId} DELETE /api/v1/projects/{projectId} ``` -------------------------------- ### Capmo API: Project Plans and Folders Source: https://capmoapi.readme.io/reference/getorganisationmembership Endpoints for managing project plans and their associated folders, including creation, retrieval, updates, and deletion operations. ```APIDOC DELETE /api/v1/projects/{projectId}/plan-folders/{folderId} POST /api/v1/projects/{projectId}/plans GET /api/v1/projects/{projectId}/plans GET /api/v1/projects/{projectId}/plans/{planId} DELETE /api/v1/projects/{projectId}/plans/{planId} PATCH /api/v1/projects/{projectId}/plans/{planId} ``` -------------------------------- ### Manage Projects API Source: https://capmoapi.readme.io/reference/getprojectplanslist API endpoints for managing projects. This includes retrieving lists of projects, creating new projects, and performing CRUD operations (Get, Update, Delete) on individual project records. ```APIDOC GET /api/v1/projects POST /api/v1/projects GET /api/v1/projects/{projectId} PATCH /api/v1/projects/{projectId} DELETE /api/v1/projects/{projectId} ``` -------------------------------- ### Capmo REST API: Project Plan Folder Management Source: https://capmoapi.readme.io/reference/webhooks API endpoints for managing plan folders within a specific project, including operations for listing, creating, and updating folders. ```APIDOC /api/v1/projects/{projectId}/plan-folders GET: List all plan folders in a project. POST: Create a new plan folder in a project. /api/v1/projects/{projectId}/plan-folders/{folderId} PATCH: Update details of a specific plan folder by ID. ``` -------------------------------- ### Manage Project Plans and Plan Folders API Source: https://capmoapi.readme.io/reference/getprojectdocumentfolder Provides endpoints for creating, retrieving, updating, and deleting project plans and their associated folders within Capmo. ```APIDOC DELETE /api/v1/projects/{projectId}/plan-folders/{folderId} - Deletes a specific plan folder. POST /api/v1/projects/{projectId}/plans - Creates a new project plan. GET /api/v1/projects/{projectId}/plans - Retrieves a list of project plans. GET /api/v1/projects/{projectId}/plans/{planId} - Retrieves a specific project plan by ID. DELETE /api/v1/projects/{projectId}/plans/{planId} - Deletes a specific project plan. PATCH /api/v1/projects/{projectId}/plans/{planId} - Updates a specific project plan. ``` -------------------------------- ### Manage Project Templates API Endpoints Source: https://capmoapi.readme.io/reference/getorganisationcompanies Provides API endpoints for accessing project templates. This includes functionalities to retrieve a list of all available project templates and to get details for a specific template by its ID. ```APIDOC GET /api/v1/project-templates - Description: Retrieve a list of all available project templates. GET /api/v1/project-templates/{projectTemplateId} - Description: Retrieve details for a specific project template by its unique identifier. - Parameters: - projectTemplateId: (Path Parameter) The unique ID of the project template. ``` -------------------------------- ### Manage Project Plans and Folders API Source: https://capmoapi.readme.io/reference/createprojectplan Endpoints for creating, retrieving, updating, and deleting project plans and managing plan folders within a project. The creation of a plan requires obtaining an upload URL first. ```APIDOC DELETE /api/v1/projects/{projectId}/plan-folders/{folderId} - Deletes a specific plan folder. POST /api/v1/projects/{projectId}/plans - Creates a new project plan. This must be called after obtaining an upload URL. GET /api/v1/projects/{projectId}/plans - Retrieves a list of project plans. GET /api/v1/projects/{projectId}/plans/{planId} - Retrieves details of a specific project plan. DELETE /api/v1/projects/{projectId}/plans/{planId} - Deletes a specific project plan. PATCH /api/v1/projects/{projectId}/plans/{planId} - Updates details of a specific project plan. ``` -------------------------------- ### Capmo API: Project Memberships Endpoints Source: https://capmoapi.readme.io/reference/createprojectticketattachment This section describes the REST API endpoints for managing memberships within a project. It supports operations to retrieve, invite, get details of, and revoke project memberships. ```APIDOC GET /api/v1/projects/{projectId}/memberships POST /api/v1/projects/{projectId}/memberships GET /api/v1/projects/{projectId}/memberships/{membershipId} DELETE /api/v1/projects/{projectId}/memberships/{membershipId} ``` -------------------------------- ### Capmo API: Organisation Memberships Endpoints Source: https://capmoapi.readme.io/reference/createprojectticketattachment This section describes the REST API endpoints for managing memberships within an organisation. It provides functionalities to retrieve, invite, get details of, and revoke organisation memberships. ```APIDOC GET /api/v1/organisation/memberships POST /api/v1/organisation/memberships GET /api/v1/organisation/memberships/{membershipId} DELETE /api/v1/organisation/memberships/{membershipId} ``` -------------------------------- ### Initiate File Uploads API Source: https://capmoapi.readme.io/reference/getprojects API endpoints for initiating file uploads for various project assets, such as document files, plans, and ticket attachments. These endpoints likely return pre-signed URLs or similar mechanisms for direct file upload. ```APIDOC POST /api/v1/upload/projects/{projectId}/document-files - Initiates upload for project document files. POST /api/v1/upload/plans - Initiates upload for project plans. POST /api/v1/upload/ticket-attachments - Initiates upload for project ticket attachments. ``` -------------------------------- ### Capmo API: Project Plans Management Source: https://capmoapi.readme.io/reference/getprojectcompany API endpoints for managing project plans within Capmo, including creation, retrieval, update, and deletion. Detailed parameter and response schemas are not provided in the source text. ```APIDOC POST /api/v1/projects/{projectId}/plans - Create a new project plan. GET /api/v1/projects/{projectId}/plans - Retrieve a list of project plans for a specific project. GET /api/v1/projects/{projectId}/plans/{planId} - Retrieve a specific project plan by its ID. DELETE /api/v1/projects/{projectId}/plans/{planId} - Delete a specific project plan by its ID. PATCH /api/v1/projects/{projectId}/plans/{planId} - Update an existing project plan by its ID. ``` -------------------------------- ### Manage Projects API Endpoints Source: https://capmoapi.readme.io/reference/createprojectdocument Endpoints for managing projects, including retrieving lists of projects, creating new projects, and performing CRUD operations (Get, Update, Delete) on specific project records. ```APIDOC GET /api/v1/projects POST /api/v1/projects GET /api/v1/projects/{projectId} PATCH /api/v1/projects/{projectId} DELETE /api/v1/projects/{projectId} ``` -------------------------------- ### Capmo Project Ticket Comments and Attachments API Endpoints Source: https://capmoapi.readme.io/reference API endpoints for managing comments and attachments associated with project tickets. This includes retrieving comments, and managing ticket attachments (getting, creating, deleting). ```APIDOC GET /api/v1/projects/{projectId}/tickets/{ticketId}/comments GET /api/v1/projects/{projectId}/tickets/{ticketId}/attachments POST /api/v1/projects/{projectId}/tickets/{ticketId}/attachments GET /api/v1/projects/{projectId}/tickets/{ticketId}/attachments/{attachmentId} DELETE /api/v1/projects/{projectId}/tickets/{ticketId}/attachments/{attachmentId} ``` -------------------------------- ### Manage Projects API Endpoints Source: https://capmoapi.readme.io/reference/getplanfolders Includes API endpoints for comprehensive project management, covering creation, retrieval, updates, and deletion of project entities. ```APIDOC GET /api/v1/projects POST /api/v1/projects GET /api/v1/projects/{projectId} PATCH /api/v1/projects/{projectId} DELETE /api/v1/projects/{projectId} ``` -------------------------------- ### Capmo API: Projects Endpoints Source: https://capmoapi.readme.io/reference/getprojectmembership Endpoints for managing projects, including creation of new projects, retrieval of project lists, and performing CRUD operations (Get, Patch, Delete) on specific project records by ID. ```APIDOC GET /api/v1/projects POST /api/v1/projects GET /api/v1/projects/{projectId} PATCH /api/v1/projects/{projectId} DELETE /api/v1/projects/{projectId} ``` -------------------------------- ### Manage Project Templates API Endpoints Source: https://capmoapi.readme.io/reference/createplanfolder This section details the API endpoints for interacting with project templates. It allows for the retrieval of a list of available project templates and fetching detailed information for a specific template by its unique identifier. ```APIDOC GET /api/v1/project-templates - Retrieves a paginated list of all available project templates. - Parameters: None. - Returns: A list of project template objects. GET /api/v1/project-templates/{projectTemplateId} - Retrieves detailed information for a specific project template by its unique ID. - Parameters: {projectTemplateId} (path parameter, string) - The ID of the project template. - Returns: A single project template object. ``` -------------------------------- ### Capmo API: Organisation Companies Endpoints Source: https://capmoapi.readme.io/reference/getprojectmembership Endpoints for managing company records associated with an organisation, allowing for the creation, retrieval of lists, and specific CRUD operations (Get, Patch, Delete) on company records by ID. ```APIDOC GET /api/v1/organisation/companies POST /api/v1/organisation/companies GET /api/v1/organisation/companies/{companyId} PATCH /api/v1/organisation/companies/{companyId} DELETE /api/v1/organisation/companies/{companyId} ``` -------------------------------- ### Manage Project Plans and Folders API Source: https://capmoapi.readme.io/reference/getprojecttemplates API endpoints for creating, retrieving, updating, and deleting project plans and managing plan folders within a project. ```APIDOC DELETE /api/v1/projects/{projectId}/plan-folders/{folderId} POST /api/v1/projects/{projectId}/plans GET /api/v1/projects/{projectId}/plans GET /api/v1/projects/{projectId}/plans/{planId} DELETE /api/v1/projects/{projectId}/plans/{planId} PATCH /api/v1/projects/{projectId}/plans/{planId} ``` -------------------------------- ### Manage Project Plans and Folders API Source: https://capmoapi.readme.io/reference/errors This section details the API endpoints for creating, retrieving, updating, and deleting project plans and their associated folders within the Capmo platform. It includes operations for individual plans and folder management. ```APIDOC DELETE /api/v1/projects/{projectId}/plan-folders/{folderId} POST /api/v1/projects/{projectId}/plans GET /api/v1/projects/{projectId}/plans GET /api/v1/projects/{projectId}/plans/{planId} DELETE /api/v1/projects/{projectId}/plans/{planId} PATCH /api/v1/projects/{projectId}/plans/{planId} ``` -------------------------------- ### Capmo API: Projects Endpoints Source: https://capmoapi.readme.io/reference/revokeorganisationmembership Core endpoints for managing projects within Capmo. This allows for listing all projects, creating new projects, and performing detailed operations (Get, Update, Delete) on individual project records. ```APIDOC GET /api/v1/projects POST /api/v1/projects GET /api/v1/projects/{projectId} PATCH /api/v1/projects/{projectId} DELETE /api/v1/projects/{projectId} ``` -------------------------------- ### Capmo API: Organisation Memberships Endpoints Source: https://capmoapi.readme.io/reference/getprojects Endpoints for managing memberships within an organisation, including retrieving membership lists, inviting new people to the organisation, getting details of specific memberships, and revoking existing memberships. ```APIDOC GET /api/v1/organisation/memberships POST /api/v1/organisation/memberships GET /api/v1/organisation/memberships/{membershipId} DELETE /api/v1/organisation/memberships/{membershipId} ``` -------------------------------- ### Capmo API: Project Plans Endpoints Source: https://capmoapi.readme.io/reference/createprojectticketattachment This section outlines the REST API endpoints for managing plan folders within a project. It provides functionalities to retrieve, create, and update project plan folders. ```APIDOC GET /api/v1/projects/{projectId}/plan-folders POST /api/v1/projects/{projectId}/plan-folders PATCH /api/v1/projects/{projectId}/plan-folders/{folderId} ``` -------------------------------- ### Manage Project Memberships API Source: https://capmoapi.readme.io/reference/getprojectplanslist API endpoints for managing memberships within specific projects. This includes retrieving project membership lists, inviting people to a project, and performing Get and Revoke operations on project memberships. ```APIDOC GET /api/v1/projects/{projectId}/memberships POST /api/v1/projects/{projectId}/memberships GET /api/v1/projects/{projectId}/memberships/{membershipId} DELETE /api/v1/projects/{projectId}/memberships/{membershipId} ``` -------------------------------- ### Capmo REST API: Project Plans Endpoints Source: https://capmoapi.readme.io/reference/createprojectcompanyfromorganisation Provides API endpoints for managing plan folders within projects, including retrieval, creation, and update of plan folder records. ```APIDOC /api/v1/projects/{projectId}/plan-foldersget (GET) - Get plan folders /api/v1/projects/{projectId}/plan-folderspost (POST) - Create plan folder /api/v1/projects/{projectId}/plan-folders/{folderId}patch (PATCH) - Update plan folder ``` -------------------------------- ### Capmo API: Projects Endpoints Source: https://capmoapi.readme.io/reference/createproject This section provides API endpoints for comprehensive project management, including operations to retrieve, create, update, and delete projects within the Capmo platform. ```APIDOC GET /api/v1/projects - Retrieve all projects. POST /api/v1/projects - Create a new project. GET /api/v1/projects/{projectId} - Retrieve a specific project by its ID. PATCH /api/v1/projects/{projectId} - Update the details of a specific project by its ID. DELETE /api/v1/projects/{projectId} - Delete a specific project by its ID. ``` -------------------------------- ### Manage Organisation Memberships API Source: https://capmoapi.readme.io/reference/getprojectplanslist API endpoints for managing memberships within an organization. This includes retrieving membership lists, inviting new people to the organization, and performing Get, Update, and Revoke operations on existing memberships. ```APIDOC GET /api/v1/organisation/memberships POST /api/v1/organisation/memberships GET /api/v1/organisation/memberships/{membershipId} PATCH /api/v1/organisation/memberships/{membershipId} DELETE /api/v1/organisation/memberships/{membershipId} ``` -------------------------------- ### Capmo REST API: Project Templates Endpoints Source: https://capmoapi.readme.io/reference/createprojectcompanyfromorganisation Provides API endpoints for retrieving project templates, allowing access to predefined project structures. ```APIDOC /api/v1/project-templatesget (GET) - Get project templates /api/v1/project-templates/{projectTemplateId}get (GET) - Get project template by ID ``` -------------------------------- ### Manage Projects API Endpoints Source: https://capmoapi.readme.io/reference/getorganisationmemberships This section covers the API endpoints for managing projects. It enables operations such as retrieving all projects, creating new projects, and performing CRUD operations (Get, Update, Delete) on individual project records. ```APIDOC GET /api/v1/projects POST /api/v1/projects GET /api/v1/projects/{projectId} PATCH /api/v1/projects/{projectId} DELETE /api/v1/projects/{projectId} ``` -------------------------------- ### Capmo Project Plans and Folders API Source: https://capmoapi.readme.io/reference/getproject Endpoints for managing project plans and their associated folders, including creation, retrieval, updates, and deletion of plans and folders. ```APIDOC DELETE /api/v1/projects/{projectId}/plan-folders/{folderId} POST /api/v1/projects/{projectId}/plans GET /api/v1/projects/{projectId}/plans GET /api/v1/projects/{projectId}/plans/{planId} DELETE /api/v1/projects/{projectId}/plans/{planId} PATCH /api/v1/projects/{projectId}/plans/{planId} ``` -------------------------------- ### Capmo REST API Endpoints for Projects Source: https://capmoapi.readme.io/reference/deleteprojectticketattachment API endpoints for managing projects. This includes retrieving lists of projects, creating new projects, and performing CRUD operations (Get, Update, Delete) on specific project records. ```APIDOC GET /api/v1/projects POST /api/v1/projects GET /api/v1/projects/{projectId} PATCH /api/v1/projects/{projectId} DELETE /api/v1/projects/{projectId} ``` -------------------------------- ### Capmo API: Organisation Memberships Endpoints Source: https://capmoapi.readme.io/reference/deleteprojectticket API endpoints for managing memberships within an organization, allowing for retrieval of all memberships, inviting new people, and specific operations (GET, PATCH, DELETE) on individual membership IDs. ```APIDOC GET /api/v1/organisation/memberships POST /api/v1/organisation/memberships GET /api/v1/organisation/memberships/{membershipId} PATCH /api/v1/organisation/memberships/{membershipId} DELETE /api/v1/organisation/memberships/{membershipId} ``` -------------------------------- ### Manage Capmo Project Plans and Folders API Source: https://capmoapi.readme.io/reference/getdocumentuploadurl API endpoints for creating, retrieving, updating, and deleting project plans, and managing plan folders within Capmo projects. ```APIDOC DELETE /api/v1/projects/{projectId}/plan-folders/{folderId} - Deletes a specific plan folder. POST /api/v1/projects/{projectId}/plans - Creates a new project plan. GET /api/v1/projects/{projectId}/plans - Retrieves a list of project plans. GET /api/v1/projects/{projectId}/plans/{planId} - Retrieves a specific project plan by ID. DELETE /api/v1/projects/{projectId}/plans/{planId} - Deletes a specific project plan by ID. PATCH /api/v1/projects/{projectId}/plans/{planId} - Updates a specific project plan by ID. ``` -------------------------------- ### Manage Project Plans API Endpoints Source: https://capmoapi.readme.io/reference/createprojectdocumentfolder API endpoints for retrieving, creating, and updating plan folders within a project. ```APIDOC GET /api/v1/projects/{projectId}/plan-folders POST /api/v1/projects/{projectId}/plan-folders PATCH /api/v1/projects/{projectId}/plan-folders/{folderId} ``` -------------------------------- ### Project Memberships API Endpoints Source: https://capmoapi.readme.io/reference/deleteproject Endpoints for managing memberships within projects. This includes retrieving project-specific memberships, inviting new people to a project, getting details of a specific project membership, and revoking project memberships. ```APIDOC GET /api/v1/projects/{projectId}/memberships POST /api/v1/projects/{projectId}/memberships GET /api/v1/projects/{projectId}/memberships/{membershipId} DELETE /api/v1/projects/{projectId}/memberships/{membershipId} ``` -------------------------------- ### Capmo Project Tickets API Source: https://capmoapi.readme.io/reference/deletecompany Provides endpoints for managing project tickets, including creating new tickets, retrieving lists of tickets, and performing specific operations on individual tickets such as getting details, updating, or deleting them. ```APIDOC /api/v1/projects/{projectId}/tickets GET /api/v1/projects/{projectId}/tickets POST /api/v1/projects/{projectId}/tickets/{ticketId} GET /api/v1/projects/{projectId}/tickets/{ticketId} PATCH /api/v1/projects/{projectId}/tickets/{ticketId} DELETE ``` -------------------------------- ### Project Plans and Plan Folders API Endpoints Source: https://capmoapi.readme.io/reference/createproject Provides a collection of API endpoints for managing project plans and their associated folders within the Capmo platform. This includes operations for creating, retrieving, updating, and deleting plans and plan folders. ```APIDOC DELETE /api/v1/projects/{projectId}/plan-folders/{folderId} POST /api/v1/projects/{projectId}/plans GET /api/v1/projects/{projectId}/plans GET /api/v1/projects/{projectId}/plans/{planId} DELETE /api/v1/projects/{projectId}/plans/{planId} PATCH /api/v1/projects/{projectId}/plans/{planId} ``` -------------------------------- ### Project Plans API Endpoints Source: https://capmoapi.readme.io/reference/where-to-start API endpoints for managing project plans and plan folders within the Capmo platform. This includes operations for creating, retrieving, updating, and deleting plans and folders. ```APIDOC DELETE /api/v1/projects/{projectId}/plan-folders/{folderId} POST /api/v1/projects/{projectId}/plans GET /api/v1/projects/{projectId}/plans GET /api/v1/projects/{projectId}/plans/{planId} DELETE /api/v1/projects/{projectId}/plans/{planId} PATCH /api/v1/projects/{projectId}/plans/{planId} ``` -------------------------------- ### Capmo API: Project Management Source: https://capmoapi.readme.io/index Endpoints for managing projects, including operations to retrieve lists of projects, create new projects, and perform specific actions (get, update, delete) on individual project records identified by their ID. ```APIDOC GET /api/v1/projects POST /api/v1/projects GET /api/v1/projects/{projectId} PATCH /api/v1/projects/{projectId} DELETE /api/v1/projects/{projectId} ``` -------------------------------- ### Capmo API Key Authentication Header Source: https://capmoapi.readme.io/index Example of the Authorization header required for authenticating requests to the Capmo API using an API key. The 'Capmo' prefix identifies the token type, ensuring proper system recognition and secure access. ```HTTP Authorization: Capmo YOUR_API_KEY ``` -------------------------------- ### Project Plans API Endpoints Source: https://capmoapi.readme.io/reference/createprojectplan Manages plan folders within projects, allowing for listing, creating, and updating plan folder details. ```APIDOC /api/v1/projects/{projectId}/plan-folders (GET) /api/v1/projects/{projectId}/plan-folders (POST) /api/v1/projects/{projectId}/plan-folders/{folderId} (PATCH) ``` -------------------------------- ### Capmo REST API - Organisation Memberships Endpoints Source: https://capmoapi.readme.io/reference/updateprojectcompany Provides endpoints for managing memberships within an organization, including retrieving membership lists, inviting new people, getting details of a specific membership, updating, and revoking memberships. ```APIDOC GET /api/v1/organisation/memberships POST /api/v1/organisation/memberships GET /api/v1/organisation/memberships/{membershipId} PATCH /api/v1/organisation/memberships/{membershipId} DELETE /api/v1/organisation/memberships/{membershipId} ``` -------------------------------- ### Manage File Uploads API Source: https://capmoapi.readme.io/reference/getprojectticketspaginated This section details API endpoints for initiating file uploads for various Capmo entities, including project documents, plans, and ticket attachments, by obtaining pre-signed upload URLs. ```APIDOC Uploads: POST /api/v1/upload/projects/{projectId}/document-files - Description: Obtain a URL for uploading project document files. POST /api/v1/upload/plans - Description: Obtain a URL for uploading project plans. POST /api/v1/upload/ticket-attachments - Description: Obtain a URL for uploading ticket attachments. ``` -------------------------------- ### Project Templates API Endpoints Source: https://capmoapi.readme.io/reference/createprojectplan Provides access to project templates, allowing for listing all available templates and retrieving details of a specific template. ```APIDOC /api/v1/project-templates (GET) /api/v1/project-templates/{projectTemplateId} (GET) ``` -------------------------------- ### Capmo API: Project Management Endpoints Source: https://capmoapi.readme.io/reference/getprojecttickettypes Endpoints for managing projects, including retrieving lists of projects, creating new project records, and performing specific operations (get, update, delete) on individual project records by ID. ```APIDOC GET /api/v1/projects POST /api/v1/projects GET /api/v1/projects/{projectId} PATCH /api/v1/projects/{projectId} DELETE /api/v1/projects/{projectId} ``` -------------------------------- ### Capmo API: Project People Endpoints Source: https://capmoapi.readme.io/reference/getprojectpeople This section outlines the API endpoints for managing people associated with specific projects. It includes functionalities to get, add, update, and remove project-specific person assignments, including adding from organization. ```APIDOC GET /api/v1/projects/{projectId}/people POST /api/v1/projects/{projectId}/people GET /api/v1/projects/{projectId}/people/{personId} PATCH /api/v1/projects/{projectId}/people/{personId} DELETE /api/v1/projects/{projectId}/people/{personId} POST /api/v1/projects/{projectId}/people-from-organisation ``` -------------------------------- ### Capmo API: Project Plans Endpoints Source: https://capmoapi.readme.io/reference/getprojecttemplate Endpoints for managing plan folders within a project, allowing for the retrieval, creation, and updating of these organisational structures. ```APIDOC GET /api/v1/projects/{projectId}/plan-folders POST /api/v1/projects/{projectId}/plan-folders PATCH /api/v1/projects/{projectId}/plan-folders/{folderId} ``` -------------------------------- ### Capmo API: Organisation Memberships Endpoints Source: https://capmoapi.readme.io/reference/getprojectmembership Endpoints for managing memberships within an organisation, including retrieving lists of memberships, inviting new people to the organisation, and performing Get, Update, and Revoke operations on specific memberships by ID. ```APIDOC GET /api/v1/organisation/memberships POST /api/v1/organisation/memberships GET /api/v1/organisation/memberships/{membershipId} PATCH /api/v1/organisation/memberships/{membershipId} DELETE /api/v1/organisation/memberships/{membershipId} ``` -------------------------------- ### Project Templates API Endpoints Source: https://capmoapi.readme.io/reference/where-to-start API endpoints for accessing project templates, allowing retrieval of available templates and details for specific templates. ```APIDOC GET /api/v1/project-templates - Retrieves a list of available project templates. GET /api/v1/project-templates/{projectTemplateId} - Retrieves details for a specific project template by ID. ``` -------------------------------- ### Capmo API: Get Plan Upload URL Details Source: https://capmoapi.readme.io/reference/getplanuploadurl Detailed documentation for the POST endpoint used to obtain a pre-signed upload URL for a new plan file. This endpoint is crucial for initiating file uploads to the Capmo platform. ```APIDOC Endpoint: /api/v1/upload/plans Method: POST Base URL: https://api.capmo.de/api/v1/upload/plans Description: This endpoint is used to obtain an upload URL for a new plan file. Supported Languages for Client Implementation: Shell, Node, Ruby, PHP, Python Authentication: Requires credentials in the Header. ``` -------------------------------- ### Capmo API: Project Templates Endpoints Source: https://capmoapi.readme.io/reference/createprojectticketattachment This section lists the REST API endpoints for accessing project templates. It allows for retrieving a list of all available templates and fetching details for a specific template. ```APIDOC GET /api/v1/project-templates GET /api/v1/project-templates/{projectTemplateId} ``` -------------------------------- ### Manage Projects API Endpoints Source: https://capmoapi.readme.io/reference/getorganisationcompanies Provides API endpoints for managing projects. This includes operations to retrieve lists of projects, create new projects, and perform CRUD operations (Get, Update, Delete) on individual project records. ```APIDOC GET /api/v1/projects - Description: Retrieve a list of all projects. POST /api/v1/projects - Description: Create a new project. GET /api/v1/projects/{projectId} - Description: Retrieve details for a specific project by its unique identifier. - Parameters: - projectId: (Path Parameter) The unique ID of the project. PATCH /api/v1/projects/{projectId} - Description: Update an existing project record identified by its ID. - Parameters: - projectId: (Path Parameter) The unique ID of the project to update. DELETE /api/v1/projects/{projectId} - Description: Delete a project record by its ID. - Parameters: - projectId: (Path Parameter) The unique ID of the project to delete. ``` -------------------------------- ### Manage File Uploads API Source: https://capmoapi.readme.io/reference/getprojectplan API endpoints for initiating file uploads for various project assets like documents, plans, and ticket attachments. ```APIDOC POST /api/v1/upload/projects/{projectId}/document-files POST /api/v1/upload/plans POST /api/v1/upload/ticket-attachments ``` -------------------------------- ### Projects API Endpoints Source: https://capmoapi.readme.io/reference/deleteproject Endpoints for managing projects within the Capmo system. This includes operations to retrieve all projects, create new projects, and perform detailed actions (get, update, delete) on specific project records by their ID. ```APIDOC GET /api/v1/projects POST /api/v1/projects GET /api/v1/projects/{projectId} PATCH /api/v1/projects/{projectId} DELETE /api/v1/projects/{projectId} ``` -------------------------------- ### Capmo REST API: Projects Endpoints Source: https://capmoapi.readme.io/reference/createprojectcompanyfromorganisation Provides API endpoints for managing projects, including retrieval, creation, update, and deletion of project records. ```APIDOC /api/v1/projectsget (GET) - Get projects /api/v1/projectspost (POST) - Create project /api/v1/projects/{projectId}get (GET) - Get project by ID /api/v1/projects/{projectId}patch (PATCH) - Update project by ID /api/v1/projects/{projectId}delete (DELETE) - Delete project by ID ``` -------------------------------- ### Manage Organisation Memberships API Endpoints Source: https://capmoapi.readme.io/reference/createprojectdocument Endpoints for managing memberships within an organisation, including retrieving membership lists, inviting new people to the organisation, and performing operations (Get, Update, Revoke) on specific membership records. ```APIDOC GET /api/v1/organisation/memberships POST /api/v1/organisation/memberships GET /api/v1/organisation/memberships/{membershipId} PATCH /api/v1/organisation/memberships/{membershipId} DELETE /api/v1/organisation/memberships/{membershipId} ``` -------------------------------- ### Capmo Project Plans API Source: https://capmoapi.readme.io/reference/getprojecttickettypes API endpoints for managing project plans and plan folders within Capmo, including creation, retrieval, update, and deletion. ```APIDOC DELETE /api/v1/projects/{projectId}/plan-folders/{folderId} - Deletes a specific plan folder. POST /api/v1/projects/{projectId}/plans - Creates a new project plan. GET /api/v1/projects/{projectId}/plans - Retrieves a list of project plans. GET /api/v1/projects/{projectId}/plans/{planId} - Retrieves details for a specific project plan. DELETE /api/v1/projects/{projectId}/plans/{planId} - Deletes a specific project plan. PATCH /api/v1/projects/{projectId}/plans/{planId} - Updates details for a specific project plan. ``` -------------------------------- ### Capmo API: Organisation Company Management Source: https://capmoapi.readme.io/index Endpoints for managing companies associated with an organization, allowing for retrieval of company lists, creation of new company records, and specific operations (get, update, delete) on individual company records by ID. ```APIDOC GET /api/v1/organisation/companies POST /api/v1/organisation/companies GET /api/v1/organisation/companies/{companyId} PATCH /api/v1/organisation/companies/{companyId} DELETE /api/v1/organisation/companies/{companyId} ``` -------------------------------- ### Manage Project Plans and Folders API Source: https://capmoapi.readme.io/reference/getprojects API endpoints for creating, retrieving, updating, and deleting project plans and their associated folders within a project. Detailed request/response schemas are not provided in the source. ```APIDOC DELETE /api/v1/projects/{projectId}/plan-folders/{folderId} - Deletes a specific plan folder. POST /api/v1/projects/{projectId}/plans - Creates a new project plan. GET /api/v1/projects/{projectId}/plans - Retrieves a paginated list of project plans. GET /api/v1/projects/{projectId}/plans/{planId} - Retrieves details for a specific project plan by ID. DELETE /api/v1/projects/{projectId}/plans/{planId} - Deletes a specific project plan by ID. PATCH /api/v1/projects/{projectId}/plans/{planId} - Updates details for a specific project plan by ID. ``` -------------------------------- ### Capmo REST API: Organisation People Endpoints Source: https://capmoapi.readme.io/reference/webhookchangeorderupdated Manages people within an organization, including retrieving lists of people, creating new person records, and performing CRUD operations (Get, Update, Delete) on individual person entries. ```APIDOC GET /api/v1/organisation/people POST /api/v1/organisation/people GET /api/v1/organisation/people/{personId} PATCH /api/v1/organisation/people/{personId} DELETE /api/v1/organisation/people/{personId} ``` -------------------------------- ### Capmo API: Project Plans Endpoints Source: https://capmoapi.readme.io/reference/inviteorganisationperson Endpoints for managing plan folders within a specific project, including retrieving, creating, and updating plan folders. ```APIDOC GET /api/v1/projects/{projectId}/plan-folders - Description: Retrieve a list of all plan folders within a specific project. - Parameters: - projectId: The unique identifier of the project. POST /api/v1/projects/{projectId}/plan-folders - Description: Create a new plan folder within a specific project. - Parameters: - projectId: The unique identifier of the project. PATCH /api/v1/projects/{projectId}/plan-folders/{folderId} - Description: Update an existing plan folder's details by its ID within a project. - Parameters: - projectId: The unique identifier of the project. - folderId: The unique identifier of the plan folder. ```