Skip to content
/
Get Project

Get Project

Request

Gets a specific project's full details.

Security
ApiKey
Path
idstring, (uuid)required

ID of the resource

curl -i -X GET \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/projects/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring, (uuid)

The unique identifier for the Project in Parallax.

namestring

The name of the Project, typically describing the work engagement or scope for the Client.

client_idstring or null, (uuid)

Id of the Client associated with this Project.

stage_idstring or null, (uuid)

Id of the Project's current Pipeline Stage.

project_owner_idstring or null, (uuid)

Id of the Person who owns this Project.

sales_owner_idstring or null, (uuid)

Id of the Person who is responsible for the sale of this Project.

start_datestring, (date)

The scheduled start date for the Project’s resource plan.

end_datestring, (date)

The scheduled end date for the Project’s resource plan.

target_budgetobject(Money)

The target budget for the Project, representing the expected revenue from the Client.

target_marginnumber, (double)

Target margin for the Project. Defaults to Organization's target margin.

currency_codestring

Currency code for the Project. Defaults to Organization's currency code.

statusstring(ProjectStatus)

Status for the Project. Default is pre_sale.

Enum:"pre_sale""awaiting_start""completed""in_progress""on_hold"
project_modelstring(ProjectModel)

Project model. Default is client.

Enum:"client""internal"
archivedboolean

Indicates whether the Project is archived and no longer active for delivery or planning.

is_includedboolean

Manual flag to hide Projects from reports while keeping them visible in the UI.

tagsArray of strings

A list of tags assigned to the Project for filtering, categorization, or reporting.

created_datestring, (date-time)

The date and time when the Project record was created in Parallax.

modified_datestring, (date-time)

The date and time when the Project record was last modified in Parallax.

external_idsArray of strings

All external IDs associated with the Project. Parallax-managed integrations use the delimited format 'px_{provider}:{id}' (e.g., 'px_hubspot:12345678901').

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
  "stage_id": "f38d2b9c-0a0a-4eea-91a8-e974413bb670",
  "project_owner_id": "b9aa7b7d-b8d6-4d27-8b60-ee4047e91304",
  "sales_owner_id": "419a49b7-d698-4d74-87b6-314cb4da4e7d",
  "start_date": "2019-08-24",
  "end_date": "2019-08-24",
  "target_budget": {
    "currency_code": "string",
    "amount": 0
  },
  "target_margin": 0.1,
  "currency_code": "string",
  "status": "pre_sale",
  "project_model": "client",
  "archived": true,
  "is_included": true,
  "tags": [
    "string"
  ],
  "created_date": "2019-08-24T14:15:22Z",
  "modified_date": "2019-08-24T14:15:22Z",
  "external_ids": [
    "string"
  ]
}