{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9d5f90da-7fee-4161-ac13-1dc3ab070d37","name":"Workspace API v2","description":"## Workspace.pm APIs: Supercharge Your Project Management\n\nWorkspace.pm's APIs form the backbone of its project management platform. By connecting and optimizing portfolio and project workflows globally, these APIs empower your users to organize and manage projects seamlessly.\n\n---\n\n### 🔖 What’s a REST API?\n\nAt its core, an API (Application Programming Interface) enables different software systems to communicate effortlessly. The workspace.pm API uses REST (Representational State Transfer), an architectural style that leverages HTTP protocols to facilitate data exchange and interaction.\n\nIn simple terms, REST APIs define endpoints (URLs) that represent resources such as projects, tasks, or team structures. These endpoints return data—typically in JSON format—that you can use to integrate and automate project workflows.\n\n#### Key Features of Workspace.pm’s REST API:\n\n- **HTTP Methods:** Actions like `GET`, `POST`, `PATCH`, and `DELETE` allow you to retrieve, create, update, or remove resources.\n    \n    - `POST`: Create new resources (e.g., add a new project).\n        \n    - `PATCH`: Update specific fields in existing resources.\n        \n- **Resource Types:** Interact with core elements like Kanban boards, timelines, and team structures.\n    \n\nBy integrating workspace.pm APIs, you can build custom dashboards, sync with external tools (e.g., CRMs or document management systems), and extend platform functionality to suit your organization’s needs.\n\n---\n\n### 🛡️ Authentication: Secure Access Made Simple\n\nWorkspace.pm APIs use HTTP Header authentication to secure data access. Follow these steps to authenticate:\n\n1. Include your API key in the header.\n    \n2. Use your workspace's subdomain as the tenant value.\n    \n\nExample request:\n\n```\ncurl -G https://pmo.yourcompany.pm \\\n  -H \"APIKEY: P61HoOkLCvTJYkkIzP2D55mfvdLvoisW\" \\\n  -H \"TENANT: pmo\"\n\n ```\n\nFind your API key under **Administration > Settings > API Settings**. If needed, regenerate the key with the `Regenerate key` button.\n\n### 📦 JSON Content Type: Speak the Language\n\nWorkspace.pm APIs require all requests to use JSON as the content type. Similarly, all API responses are returned in JSON format, ensuring consistency and ease of use.\n\n---\n\n### 🔄 Webhooks: Stay Updated in Real-Time\n\nWebhooks are like real-time notifications for your application. When specific events occur (e.g., a project is created or a user is deleted), workspace.pm triggers a webhook—a user-defined HTTP callback.\n\n#### Things to Note About Webhooks:\n\n- **Asynchronous:** Webhooks may be triggered and delivered out of sequence.\n    \n- **Event-Driven:** Use them to automate responses to events like task creation or user updates.\n    \n\nBy leveraging webhooks, you can keep your systems in sync with workspace.pm’s platform in real time.\n\n---\n\nHarness the power of workspace.pm APIs to transform your project management workflows, making integration and automation seamless. Dive into the documentation to explore more possibilities.\n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3881167","team":119854,"collectionId":"9d5f90da-7fee-4161-ac13-1dc3ab070d37","publishedId":"2sAYBaAA9e","public":true,"publicUrl":"https://dev.workspace.pm","privateUrl":"https://go.postman.co/documentation/3881167-9d5f90da-7fee-4161-ac13-1dc3ab070d37","customColor":{"top-bar":"FFFFFF","right-sidebar":"105365","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Workspace.pm's APIs form the backbone of its project management platform. By connecting and optimizing portfolio and project workflows globally, these APIs empower your users to organize and manage projects seamlessly."},{"name":"title","value":"workspace.pm API Documentation"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"105365","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"105365","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-12-05T21:40:54.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"workspace.pm API Documentation","description":"Workspace.pm's APIs form the backbone of its project management platform. By connecting and optimizing portfolio and project workflows globally, these APIs empower your users to organize and manage projects seamlessly."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Documentation Environment","id":"211901e5-fb3a-4aa2-b76b-97725f17f0bc","owner":"3881167","values":[{"key":"tenantUrl","value":"https://workspace.mycompany.pm","enabled":true,"type":"default"},{"key":"tenantSubdomain","value":"workspace","enabled":true,"type":"default"},{"key":"APIKEY","value":"APIKEY-123-ABC","enabled":true,"type":"default"},{"key":"token","value":"APIKEY-123-ABC","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/5b31b558b2a4a237e0e8eb6f247160a04050ff954803ee532853f678ba3e944f","favicon":"https://workspace.pm/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Documentation Environment","value":"3881167-211901e5-fb3a-4aa2-b76b-97725f17f0bc"}],"canonicalUrl":"https://dev.workspace.pm/view/metadata/2sAYBaAA9e"}