GET api/Projects/{id}
Returns a project by id. Note: Requires a valid access token to be provided in the request's auth header.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Id of project. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns an project by id.
CrmProject| Name | Description | Type | Additional information |
|---|---|---|---|
| StatementsOfWork |
List of related statements of work. |
Collection of CrmStatementOfWork |
Required |
| WorkOrders |
List of related work orders. |
Collection of CrmWorkOrder |
Required |
| Id |
Id of project. |
string |
Required |
| Type |
Type of project. |
string |
Required |
| Status |
Status of project. |
string |
Optional |
| Reference |
Used to reference the project in CRM. |
EntityReference |
Required |
| HomeObject |
Used to reference the related home in CRM. |
EntityReference |
Required |
| StartDate |
Start date of project. |
date |
Optional |
| EndDate |
End date of project. |
date |
Optional |
| CompletedDate |
Completed date of project. |
date |
Optional |
| ScheduledStartDate |
Scheduled start date of project. |
date |
Optional |
| ScheduledEndDate |
Scheduled end date of project. |
date |
Optional |
| EstimatedCost |
Estimated cost of project. |
decimal number |
Optional |
| CatastropheType |
Type of catastrophe of the project. |
string |
Optional |
| SystemDate |
Current system date of the client that created this object. |
date |
Optional |
| CapturedDate |
Date and time the client created this object. |
date |
Optional |
Response Formats
application/json, text/json
Sample:
{
"StatementsOfWork": [
{
"StatementOfWorkItems": [
{
"Id": "sample string 1",
"MobileUniqueIdentifier": "sample string 2",
"StatementOfWorkObject": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"Approved": true,
"Area": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"InspectionItem": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"AreaDefinition": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"InspectionItemDefinition": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"ProductOrService": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"Cost": 1.0,
"Quantity": 1.0,
"TotalCost": 1.0,
"UnitType": "sample string 3",
"TenantResponsibilityPercentage": 1.0,
"Reference": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:32:15.964246-05:00",
"CapturedDate": "2025-10-30T10:32:15.964246-05:00"
},
{
"Id": "sample string 1",
"MobileUniqueIdentifier": "sample string 2",
"StatementOfWorkObject": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"Approved": true,
"Area": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"InspectionItem": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"AreaDefinition": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"InspectionItemDefinition": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"ProductOrService": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"Cost": 1.0,
"Quantity": 1.0,
"TotalCost": 1.0,
"UnitType": "sample string 3",
"TenantResponsibilityPercentage": 1.0,
"Reference": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:32:15.964246-05:00",
"CapturedDate": "2025-10-30T10:32:15.964246-05:00"
}
],
"Id": "sample string 1",
"ApprovalStatus": "sample string 2",
"ApprovalDate": "2025-10-30T10:32:15.964246-05:00",
"ProjectObject": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"ProposedEstimatedCost": 1.0,
"ApprovedEstimatedCost": 1.0,
"CostVariance": 1.0,
"ApprovedEstimatedCostPostMarkup": 1.0,
"Type": "sample string 3",
"Media": [
{
"MediaId": 1,
"Tags": [
"sample string 1",
"sample string 2"
],
"Data": "sample string 2",
"Name": "sample string 3",
"Caption": "sample string 4",
"MediaKey": "sample string 5",
"Ordinal": 6,
"MimeType": "sample string 7",
"Url": "sample string 8",
"Latitude": 1.1,
"Longitude": 1.1,
"IsAnnotation": true,
"IsThumbnail": true,
"Height": 1,
"Width": 1,
"Reference": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:32:15.964246-05:00",
"CapturedDate": "2025-10-30T10:32:15.964246-05:00"
},
{
"MediaId": 1,
"Tags": [
"sample string 1",
"sample string 2"
],
"Data": "sample string 2",
"Name": "sample string 3",
"Caption": "sample string 4",
"MediaKey": "sample string 5",
"Ordinal": 6,
"MimeType": "sample string 7",
"Url": "sample string 8",
"Latitude": 1.1,
"Longitude": 1.1,
"IsAnnotation": true,
"IsThumbnail": true,
"Height": 1,
"Width": 1,
"Reference": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:32:15.964246-05:00",
"CapturedDate": "2025-10-30T10:32:15.964246-05:00"
}
],
"SqftVariance": "sample string 4",
"Reference": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:32:15.964246-05:00",
"CapturedDate": "2025-10-30T10:32:15.964246-05:00"
},
{
"StatementOfWorkItems": [
{
"Id": "sample string 1",
"MobileUniqueIdentifier": "sample string 2",
"StatementOfWorkObject": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"Approved": true,
"Area": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"InspectionItem": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"AreaDefinition": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"InspectionItemDefinition": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"ProductOrService": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"Cost": 1.0,
"Quantity": 1.0,
"TotalCost": 1.0,
"UnitType": "sample string 3",
"TenantResponsibilityPercentage": 1.0,
"Reference": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:32:15.964246-05:00",
"CapturedDate": "2025-10-30T10:32:15.964246-05:00"
},
{
"Id": "sample string 1",
"MobileUniqueIdentifier": "sample string 2",
"StatementOfWorkObject": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"Approved": true,
"Area": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"InspectionItem": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"AreaDefinition": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"InspectionItemDefinition": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"ProductOrService": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"Cost": 1.0,
"Quantity": 1.0,
"TotalCost": 1.0,
"UnitType": "sample string 3",
"TenantResponsibilityPercentage": 1.0,
"Reference": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:32:15.964246-05:00",
"CapturedDate": "2025-10-30T10:32:15.964246-05:00"
}
],
"Id": "sample string 1",
"ApprovalStatus": "sample string 2",
"ApprovalDate": "2025-10-30T10:32:15.964246-05:00",
"ProjectObject": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"ProposedEstimatedCost": 1.0,
"ApprovedEstimatedCost": 1.0,
"CostVariance": 1.0,
"ApprovedEstimatedCostPostMarkup": 1.0,
"Type": "sample string 3",
"Media": [
{
"MediaId": 1,
"Tags": [
"sample string 1",
"sample string 2"
],
"Data": "sample string 2",
"Name": "sample string 3",
"Caption": "sample string 4",
"MediaKey": "sample string 5",
"Ordinal": 6,
"MimeType": "sample string 7",
"Url": "sample string 8",
"Latitude": 1.1,
"Longitude": 1.1,
"IsAnnotation": true,
"IsThumbnail": true,
"Height": 1,
"Width": 1,
"Reference": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:32:15.964246-05:00",
"CapturedDate": "2025-10-30T10:32:15.964246-05:00"
},
{
"MediaId": 1,
"Tags": [
"sample string 1",
"sample string 2"
],
"Data": "sample string 2",
"Name": "sample string 3",
"Caption": "sample string 4",
"MediaKey": "sample string 5",
"Ordinal": 6,
"MimeType": "sample string 7",
"Url": "sample string 8",
"Latitude": 1.1,
"Longitude": 1.1,
"IsAnnotation": true,
"IsThumbnail": true,
"Height": 1,
"Width": 1,
"Reference": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:32:15.964246-05:00",
"CapturedDate": "2025-10-30T10:32:15.964246-05:00"
}
],
"SqftVariance": "sample string 4",
"Reference": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:32:15.964246-05:00",
"CapturedDate": "2025-10-30T10:32:15.964246-05:00"
}
],
"WorkOrders": [
{
"Reference": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:32:15.964246-05:00",
"CapturedDate": "2025-10-30T10:32:15.964246-05:00"
},
{
"Reference": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"SystemDate": "2025-10-30T10:32:15.964246-05:00",
"CapturedDate": "2025-10-30T10:32:15.964246-05:00"
}
],
"Id": "sample string 1",
"Type": "sample string 2",
"Status": "sample string 3",
"Reference": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"HomeObject": {
"Id": "9f78bb78-738f-4652-ba41-204b6deb63c2",
"LogicalName": "sample string 2",
"Name": "sample string 3"
},
"StartDate": "2025-10-30T10:32:15.964246-05:00",
"EndDate": "2025-10-30T10:32:15.964246-05:00",
"CompletedDate": "2025-10-30T10:32:15.964246-05:00",
"ScheduledStartDate": "2025-10-30T10:32:15.964246-05:00",
"ScheduledEndDate": "2025-10-30T10:32:15.964246-05:00",
"EstimatedCost": 1.0,
"CatastropheType": "sample string 4",
"SystemDate": "2025-10-30T10:32:15.964246-05:00",
"CapturedDate": "2025-10-30T10:32:15.964246-05:00"
}