For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportContact salesStart free trial
  • Getting started
    • Overview
    • Authentication
    • Querying tutorial
    • OData Integrations
    • Work Breakdown Structure
    • Software Development Kits
    • API Patch Notes
    • FAQ
    • Terms of use
  • API Reference
LogoLogo
SupportContact salesStart free trial
On this page
  • Using the API
  • Common use cases
  • Support
Getting started

Overview

Was this page helpful?

Authentication

Next
Built with

Your team can get started with the ProjectManager API right away - here’s how.

  1. All ProjectManager.com workspaces have access to the API. If you don’t have a workspace, create a free trial now!

  2. Once you have signed up for an account, any users with the Admin or Global Admin roles within your workspace can create an API key within ProjectManager. Remember to save your API key in your company’s secure credential storage system!

  3. Download the appropriate software development kit for your favorite programming language:

LanguageSource CodePackage
DotNet/C#projectmanager-sdk-csharpNuGet - Version
Python/Jupyterprojectmanager-sdk-pythonPyPI - Version
TypeScript/JavaScriptprojectmanager-sdk-typescriptNPM - Version
Javaprojectmanager-sdk-javaMaven Central
  1. Check out some example programs demonstrating how to use the ProjectManager API:
LanguageProgramNotes
C#PMTaskA command line application that demonstrates basic functionality like creating tasks. Run with dotnet run
PythonPython Task ListA basic program in Python that demonstrates connecting and retrieving tasks. Run with python .\python_task_list.py
JupyterJupyter Task DataFrameA simple Jupyter notebook that retrieves tasks and displays them in a dataframe. Open in Visual Studio Code and click “Run All”.
TypeScriptTypeScript Task ListA basic program in TypeScript that demonstrates connecting and retrieving tasks. Run with npm start
JavaJava Task ListA simple Java console application that demonstrates connecting and retrieving tasks. Run with mvn exec:java -D"exec.mainClass=com.example.ExampleApp"

Using the API

All API calls to ProjectManager.com use the URL https://api.projectmanager.com/ regardless of your workspace’s custom URL. You must use a bearer token to contact the API.

The ProjectManager.com API allows you to synchronize data from other systems to your project files and data. With the ProjectManager.com API, you can:

  • Notify your accounting system when a task is completed, so they can send an invoice to the customer
  • Import data from your internal IT systems into tasks
  • Run a security scan on your software and automatically create a task for each risk
  • Automatically synchronize comments to tasks

Common use cases

The ProjectManager API provides lots of features that you can use to help automate your day-to-day processes. One good way to get started is to look at the most commonly used APIs such as these:

  • Create a new Project
  • Query for Tasks within a Project
  • Create a Comment on a Task
  • Update a Custom Column on a Task

If you want to look at some example code, check out our ProjectManager example code repository on github.

Support

Support for ProjectManager.com and its API is available at https://www.projectmanager.com/support.

We make available information about our company’s security policies on https://trust.projectmanager.com/, and you can view the status of our product at https://status.projectmanager.com/.