PSOHub API: Projects
Learn how to retrieve and create projects in PSOhub via the API
Published: 1 June 2026
Audience
-
Admin
Objective
This reference article covers the PSOhub API endpoints for retrieving and creating projects. Use these endpoints to query existing projects and create new ones programmatically in PSOhub.
Prerequisites
You must have Admin user access in PSOhub.
You must have API access enabled for your PSOhub account.
To create a project linked to a company, the
CompanyID must be known. Retrieve it via the Companies API endpoint.Get All Projects
Use this endpoint to retrieve a list of projects from your PSOhub organization:
Endpoint
GET https://www.psohubapp.com/rest/psohubapi/v1/projects
By default, the API returns 50 projects. Use the limit parameter to retrieve more records.
GET https://www.psohubapp.com/rest/psohubapi/v1/projects?limit=150
⚠️ Important: The ProjectID is the unique identifier required for any future updates to a project. Store this value in your system when creating or retrieving projects.
Example response
json
[ { "Name": "New project for City of Boston", "StartDate": "2024-08-15T18:16:24.085Z", "ProjectTypeID": "13229323923272053", "Stage": "Active", "ProjectNumber": "PRO-2024-13", "ProjectManager": "Art Volker", "TotalProjectValue": 0, "CurrencyCode": "USD", "ProjectID": 13229323915872053, "CompanyID": 14073748835550302, "ExternalDealID": 0, "ProjectManagerID": 39406496739494241, "BusinessUnitID": 1 } ]
Response fields
| Name | Type | Description |
|---|---|---|
| Name | String | The name of the project. |
| StartDate | DateTime | The target start date of the project. |
| Stage | String (read only) | The current stage of the project (for example, Active or Proposal). |
| ProjectNumber | String | The project number as generated in PSOhub. |
| ProjectTypeID | Integer/Long | The ID of the project type. |
| ProjectManager | String (read only) | The name of the assigned project manager. |
| TotalProjectValue | Decimal | The total financial value of the project. |
| CurrencyCode | String | The currency used for the project. |
| ProjectID | Integer/Long | The unique ID of the project. Use this as the primary key for future updates. |
| CompanyID | Integer/Long | The unique ID of the associated company. |
| ExternalDealID | Integer/Long | The deal ID from a connected external CRM. |
| ProjectManagerID | Integer/Long | The unique ID of the assigned project manager. |
| BusinessUnitID | Integer/Long | The unique ID of the assigned business unit. |
Search Projects
Use query parameters to filter the project list when retrieving projects.
| Parameter | Type | Example |
|---|---|---|
| Name | String | Name=TestProject |
| Stage | String | Stage=Active |
Create a Project
Use this endpoint to create a new project in PSOhub:
Endpoint
POST https://www.psohubapp.com/rest/psohubapi/v1/project
Request fields
| Name | Required | Type | Description |
|---|---|---|---|
| Name | Yes | String | The name of the project. |
| Stage | Yes | String | The stage of the project (for example, Active or Proposal). |
| CompanyID | Yes | Integer/Long | The unique ID of the associated company. |
| StartDate | No | DateTime | The target start date of the project. |
| DealAmount | No | Decimal | The deal amount from the associated opportunity or deal. |
| ProjectTypeID | No | Integer/Long | The ID of the project type. |
| CurrencyCode | No* | String | Required only if the project currency differs from the organization's base currency. |
| ContactID | No | Integer/Long | The unique ID of the main contact for the project. |
| BusinessUnitID | No* | Integer/Long | The unique ID of the business unit. If not provided, the main business unit is assigned automatically. |
| ProjectManagerID | No | Integer/Long | The unique ID of the assigned project manager. |
| ContractTemplateID | No | Integer/Long | The unique ID of the contract template to apply to the project. |
Example request body
json
{ "Name": "API Project", "StartDate": "2024-09-09T18:14:07.153Z", "ProjectTypeID": "523523502309232", "Stage": "Active", "CurrencyCode": "USD", "CompanyID": 14073748840512521, "BusinessUnitID": 1 }
Response
On success, the API returns the ProjectID and ProjectNumber of the newly created project.
json
{ "ProjectID": "13229323916012216", "ProjectNumber": "PRO-13-2024" }
📌 Note: Store the returned ProjectID if you plan to update this project via the API in the future.