Skip to content

List Projects

Note

This API is used for getting the list of projects which the current user has permission to see.

Action Parameters Description
get page Filter with pagination.
q Filter with project name.
f Filter with status.
company Filter with company.
techStack Filter with tech stack.
tag Fitler with project tag.
startDate Filter with start date.
endDate Filter with end date.
minimumPrice Filter with minimum price for project.
maximunPrice Filter with maximun price for project.
Endpoint
GET 
/api/v2/projects/?page=1&q=&f=&project=&company=&techStack=&tag=&startDate=&endDate=&minimumPrice=&maximumPrice=

Example Request

curl --location --request GET 'https://app.engineerforce.io/api/v2/projects/?page=1'\
--header 'Authorization: API-Token {{YOUR_API_TOKEN}}'

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://app.engineerforce.io/api/v2/projects/?page=1',
  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/?page=1')
  .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/?page=1'

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

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

print(response.text)

Example Response

{
    "count": 3,
    "next": "https://app.engineerforce.io/api/v2/projects/?page=2",
    "previous": null,
    "results": [
        {
            "url": "https://app.engineerforce.io/api/v2/projects/1000/",
            "id": 1000,
            "projectName": "システム",
            "company": "ABC Ltd.",
            "creator": "tester",
            "status": "A",
            "timelineStatus": null,
            "createdAt": "2023-01-04T13:35:15.111878+09:00",
            "team": {
                "id": 100,
                "name": "Team A"
            }
        },
        {
            "url": "https://app.engineerforce.io/api/v2/projects/1001/",
            "id": 1001,
            "projectName": "testing-2",
            "company": "testing-2",
            "creator": "tester",
            "status": "A",
            "timelineStatus": null,
            "createdAt": "2022-12-30T17:55:45.914974+09:00",
            "team": {
                "id": 100,
                "name": "Team A"
            }
        },
        {
            "url": "https://app.engineerforce.io/api/v2/projects/1002/",
            "id": 1002,
            "projectName": "testing-3",
            "company": "testing-3",
            "creator": "tester",
            "status": "A",
            "timelineStatus": null,
            "createdAt": "2022-12-27T12:26:49.761830+09:00",
            "team": {
                "id": 100,
                "name": "Team A"
            }
    }]
}