Retrieves the project status with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The project status id. |
globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the project status, or 404 Not Found if it doesn't exist.
project_status| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| name |
Name of the project status |
string |
Required Max length: 50 |
| is_default |
Is default (auto selected when creating new project) |
boolean | |
| is_closed |
Inform if this status means that the project/installation is archived |
boolean |
Required |
| sales_organization_id |
FK of sales_organization. Filled if specific of one SO, empty if can be used by all |
globally unique identifier | |
| sequence |
Order in which this status should be displayed relative to other statuses. |
integer | |
| color_text |
Display color (e.g. hex code) used to render this status in the UI. |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "22d7bebe-7f19-4afe-a2c7-09d8b40ac9c0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "31c331ef-5607-459a-869d-edfb680534f4",
"sequence": 6,
"color_text": "sample string 7",
"modified_dateutc": "2026-11-12T14:27:18.7744694+00:00"
}
application/xml, text/xml
Sample:
<project_status xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <color_text>sample string 7</color_text> <id>22d7bebe-7f19-4afe-a2c7-09d8b40ac9c0</id> <is_closed>true</is_closed> <is_default>true</is_default> <modified_dateutc>2026-11-12T14:27:18.774Z</modified_dateutc> <name>sample string 2</name> <sales_organization_id>31c331ef-5607-459a-869d-edfb680534f4</sales_organization_id> <sequence>6</sequence> </project_status>