Skip to main content
GET
/
projects
Get Projects
curl --request GET \
  --url https://api.projectcor.com/v1/projects \
  --header 'Authorization: Bearer <token>'
{
  "total": "<string>",
  "perPage": 123,
  "page": 123,
  "lastPage": 123,
  "meta_data": {
    "profitability_limit": "<string>"
  },
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "brief": "<string>",
      "client_id": 123,
      "health": 1,
      "status": "active",
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z",
      "estimated_time": 123,
      "elapsed_time": 123,
      "profitability_now": 123,
      "estimated_profitability": 123,
      "archived": true,
      "billable": true,
      "income_type": "fee",
      "pm_id": 123,
      "created_by": 123,
      "company_id": 123,
      "template_id": 123,
      "brand_id": 123,
      "product_id": 123,
      "total_estimated": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "client": {
        "id": 123,
        "name": "<string>",
        "client_status_id": 123
      },
      "pm": {
        "id": 123,
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>",
        "role_id": 123
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
default:1

Page number (default: 1). Set to false to disable pagination and return all results.

perPage
integer
default:20

Number of items per page when pagination is active (default: 20).

filters
string

URL-encoded JSON object with filter criteria. Available fields: dateStart (YYYY-MM-DD), dateEnd (YYYY-MM-DD), client_id (number), team_id (number), user_id (number), brand_id (number), product_id (number), status ("finished"|"in_process"|"suspended"), health (1-4), archived (1=archived, 2=active).

Response

200 - application/json

Paginated list of projects

Paginated response for projects list

total

Total number of projects matching the filters

perPage
integer

Number of items per page

page
integer

Current page number

lastPage
integer

Last available page number

meta_data
object

Additional metadata

data
object[]

Array of projects for the current page