INinvoiceninja
projects

Show project

Changed on

Displays a project by id

get/api/v1/projects/{id}

Request

Path parameters

idstring string required

The Project Hashed ID

Query parameters

includestring
Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

Returns the expense object

idstring required

The project hashed id

user_idstring required

The user hashed id

assigned_user_idstring

The assigned user identifier associated with the project

client_idstring

The client identifier associated with the project

namestring required

The name of the project

task_ratenumber float required

The default rate per task for the project

due_datestring date

The due date for the project

private_notesstring

Private notes associated with the project

budgeted_hoursnumber float required

The number of budgeted hours for the project

custom_value1string

Custom value field 1

custom_value2string

Custom value field 2

custom_value3string

Custom value field 3

custom_value4string

Custom value field 4

created_atnumber

The timestamp of the project creation

updated_atnumber

The timestamp of the last project update

archived_atnumber

The timestamp of the project deletion

public_notesstring

Public notes associated with the project

is_deletedboolean required

A flag indicating if the project is deleted

numberstring

The project number

colorstring required

The color associated with the project

Example response

{
  "id": "Opnel5aKBz",
  "user_id": "Opnel5aKBz",
  "assigned_user_id": "Opnel5aKBz",
  "client_id": "Opnel5aKBz",
  "name": "New Project",
  "task_rate": 10,
  "due_date": "2019-01-01",
  "created_at": 134341234234,
  "updated_at": 134341234234,
  "archived_at": 134341234234,
  "tags": [
    {
      "id": "Opnel5aKBz",
      "name": "Urgent",
      "color": "#FF0000"
    }
  ]
}

Changes