Skip to main content
GET
/
projects
/
search-by-name
/
{project_name}
Get projects by name
curl --request GET \
  --url https://api.projectcor.com/v1/projects/search-by-name/{project_name} \
  --header 'Authorization: Bearer <token>'
[
  {
    "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.

Path Parameters

project_name
string
required

Response

200 - application/json

List of projects

id
integer

Unique project identifier

name
string

Project name

brief
string

Project brief/description

client_id
integer

Associated client ID

health
enum<integer>

Project health indicator: 1 (on track), 2 (at risk), 3 (delayed), 4 (critical)

Available options:
1,
2,
3,
4
status
enum<string>

Project status

Available options:
active,
finished,
suspended
start
string<date-time>

Project start date

end
string<date-time>

Project end date

estimated_time
number

Estimated hours for the project

elapsed_time
number

Hours already logged

profitability_now
number

Current profitability percentage

estimated_profitability
number

Estimated profitability percentage

archived
boolean

Whether the project is archived

billable
boolean

Whether the project is billable

income_type
enum<string>

Project billing type

Available options:
fee,
one_time,
hourly_rate,
contract
pm_id
integer

Project Manager user ID

created_by
integer

User ID who created the project

company_id
integer

Company ID

template_id
integer

Project template ID used

brand_id
integer

Associated brand ID

product_id
integer

Associated product ID

total_estimated
number

Total estimated budget

created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp

client
object

Associated client object

pm
object

Project Manager details