Skip to content

Get project data

Note

This API is used for getting project information.

Action Parameters Description
get None Get project data.
Warning

This API data may be subject to change.

Endpoint
GET
/api/v2/projects/{project_id}

The project data API is the most fundamental to all the operations in the Engineerforce system. From this API, various imformation such as approvers data, project creator data, related tasks, related expenses and discount etc.

Example Request

curl --location --request GET 'https://app.engineerforce.io/api/v2/projects/1000/'\
--header 'Authorization: API-Token {{YOUR_API_TOKEN}}'
var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://app.engineerforce.io/api/v2/projects/1000/',
  headers: { 'Authorization': 'API-Token {{YOUR_API_TOKEN}}' }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url('https://app.engineerforce.io/api/v2/projects/1000/')
  .method("GET", body)
  .addHeader("Authorization", "API-Token {{YOUR_API_TOKEN}}")
  .build();
Response response = client.newCall(request).execute();
import requests

url = 'https://app.engineerforce.io/api/v2/projects/1000/'

payload={}
headers = {'Authorization': 'API-Token {{YOUR_API_TOKEN}}' }

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Example Response

{
    "url": "https://app.engineerforce.io/api/v2/projects/1000/",
    "id": 1000,
    "projectName": "Testing",
    "companyName": "Test Inc.",
    "startDate": "2023-01-04",
    "endDate": "2023-01-31",
    "languageTags": "",
    "techStacks": "",
    "unitTasks": [{
        "unitTaskId": 100,
        "unitTaskOrdering": 0,
        "unitTaskName": "Unit Basic Task",
        "unitTaskProjectId": 1000,
        "unitTaskAssigneeId": 10,
        "unitTaskUnitPrice": 1000000.0,
        "unitTaskCostPrice": 500000.0,
        "unitTaskManhourValue": 1.0,
        "unitTaskManhourUnit": "month",
        "unitTaskIsFinished": false,
        "unitTaskRiskFactor": 0,
        "unitTaskSize": "",
        "unitTaskProductivity": "",
        "unitTaskDifficulty": null,
        "unitTaskStatus": "Todo",
        "unitTaskNote": "",
        "unitTaskStartDate": "2023-01-04",
        "unitTaskEndDate": "2023-01-31",
        "unitTaskGanttStartDate": "2023-01-04T13:34:41+09:00",
        "unitTaskGanttEndDate": "2023-01-31T13:34:43+09:00",
        "unitTaskActualTime": 0.0,
        "unitTaskProgressRate": 0,
        "created": "2023-01-04T13:35:15.125206+09:00",
        "updated": "2023-01-04T13:35:15.125238+09:00",
        "unitTaskLargeGanttStartDate": "2023-01-04T00:00:00.005000+09:00",
        "unitTaskLargeGanttEndDate": "2023-02-04T00:00:00.005000+09:00",
        "project": "Testing"
    }],
    "currency": "JPY",
    "project_risk_coe": 0,
    "creator": {
        "url": "https://app.engineerforce.io/api/v2/users/1/",
        "id": 1,
        "email": "mainuser@test.io",
        "imageUrl": "/media/images/375427ce388b4d9jcjse850f61ab97b93794.JPG",
        "companyName": "user company",
        "fullname": "John Doe",
        "firstName": "John",
        "lastName": "Doe",
        "last_login": "2022-12-30T11:26:20.348810+09:00",
        "date_joined": "2020-10-28T22:30:05+09:00",
        "is_staff": true,
        "aboutMe": "",
        "language": "Japanese,English",
        "skill": "Python,Go",
        "informationId": 10,
        "isOwner": true,
        "organizationInfo": {
            "url": "https://app.engineerforce.io/api/v2/organizations/10/",
            "name": "User Org",
            "prefix": "M3jQi7O4chsvUJcY",
            "isOwner": false,
            "isUser": true,
            "isAdminActivated": true,
            "quantity": 100,
            "ownerUsers": [
                "mainuser@test.io"
            ],
            "ownerUsersWithDetail": [{
                "name": "John Doe",
                "email": "mainuser@test.io",
                "avatarUrl": "/media/images/375427ce388bdcjjc9e850f61ab97b93794.JPG",
                "bio": "",
                "teams": [{
                        "name": "Team A",
                        "perms": [
                            "add_team",
                            "Approver",
                            "change_team",
                            "delete_team",
                            "Estimator",
                            "Owner",
                            "view_team",
                            "Watcher"
                        ]
                    }
                ]
            }],
            "normalUsersWithDetail": [],
            "normalUsers": [],
            "subscription": {},
            "limit": "You can invite 99 more members",
            "seatLeft": 99
        }
    },
    "hasSavedTemplate": false,
    "status": "A",
    "status_records": [{
            "statusKey": "D",
            "userName": "John Doe",
            "created": "2023-01-04T04:35:15.133905Z",
            "finished": 2
        },
        {
            "statusKey": "F",
            "userName": "John Doe",
            "created": "2023-01-04T04:35:23.755745Z",
            "finished": 2
        },
        {
            "statusKey": "P",
            "userName": "John Doe",
            "created": "2023-01-04T04:35:28.333686Z",
            "finished": 2
        },
        {
            "statusKey": "A",
            "userName": "",
            "created": "",
            "finished": 1
        },
        {
            "statusKey": "C",
            "userName": "",
            "created": "",
            "finished": 0
        }
    ],
    "timelineStatus": null,
    "approvers": [],
    "watchers": [],
    "task_set": [],
    "attachment_set": [],
    "timeline_update_set": [],
    "note": "",
    "projectCode": "1000",
    "projectSegment": "受託開発",
    "relatedProjects": "",
    "deliveryDates": "",
    "settings": {
        "id": "100",
        "segmentList": "Contract-Development,Sales,Support",
        "visibleFields": "",
        "project": 1000
    },
    "discount": {},
    "expense_set": [],
    "bundled_members": []
}

Response Payload Explanation