INinvoiceninja
projects

List projects

Changed on

Lists projects

get/api/v1/projects

Request

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

indexstring
Example:user

Replaces the default response index from data to a user specific string

ie.

  ?index=new_index

response is wrapped

  {
    'new_index' : [
      .....  
    ]
  }
per_pageinteger
Example:20

The number of records to return for each request, default is 20

pageinteger
Example:1

The page number to return for this request (when performing pagination), default is 1

sortstring[]

Order the list by choosing a column and direction. Each value uses the form column|asc or column|desc.

Single sort — for example sort=due_date|desc.

Multiple sorts — for example
sort[]=id|desc&sort[]=name|asc.

Projects accept projects columns plus client.name, client_id, contact.*, documents, and dotted client.* / contact.* relationship sorts where supported. Unsupported keys are ignored.

[
  "name|asc",
  "due_date|desc"
]

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

A list of projects

Example response

{
  "data": [
    {
      "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"
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Changes