Get a project status
GET/api/project-statuses/{id}
Required permissions:
- project_status.view: allows view resources of projects where the user is the PM or the Account.
- project_status.view_other: allows view resources of projects where the user is not the PM nor the Account.
Here the dedicated support page.
Request
Path Parameters
Possible values: Value must match regular expression [0-9]+
The ID of the project status to view
Query Parameters
- Exclude deleted
- Include deleted
- Only deleted
Possible values: [exclude, include, only]
Default value: exclude
Filter items by deletion status.
Exclude soft-deleted records.
Example: exclude
Include both active and soft-deleted records.
Example: include
Return only soft-deleted records.
Example: only
Header Parameters
The company you want to interact with
The API version you want to use
Responses
- 200
- 400
- 401
- 403
- 404
- 412
Returns the requested project status.
- application/json
- Schema
- Example (from schema)
Schema
Possible values: >= 1
The unique identifier of the resource
The date and time when the resource was created
The date and time when the resource was last updated
Possible values: >= 1
ID of the project to which the project status belongs
The date of the project status
The amount of days left
The percentual progress
The project status notes
Possible values: >= 1
ID of the project status risk
The date and time when the resource was deleted
{
"id": 1,
"created_at": "2025-11-11T15:33:25.383Z",
"updated_at": "2025-11-11T15:33:25.383Z",
"project_id": 1,
"date": "2025-11-11",
"days_left": 4.5,
"progress": 10,
"notes": "I am a note",
"project_status_risk_id": 1,
"deleted_at": "2025-11-11T15:33:25.383Z"
}
Validation failed
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Error unique key
Human-readable message describing the error
failures
object[]
List of validation errors
Name of the field causing the error
Human-readable description of the error
{
"key": "invalid_data",
"message": "You provided invalid data. Check 'failures' for details.",
"failures": [
{
"field": "string",
"message": "string"
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
Error unique key
Human-readable message describing the error
{
"key": "string",
"message": "string"
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Error unique key
Human-readable message describing the error
{
"key": "string",
"message": "string"
}
Not found
- application/json
- Schema
- Example (from schema)
Schema
Error unique key
Human-readable message describing the error
{
"key": "not_found",
"message": "string"
}
Precondition failed
- application/json
- Schema
- Example (from schema)
Schema
Error unique key
Human-readable message describing the error
{
"key": "precondition_failure",
"message": "string"
}