GET
/
timmi-project
/
api
/
v4
/
projects
curl --request GET \
  --url https://{host}/timmi-project/api/v4/projects \
  --header 'Authorization: <authorization>'
{
  "next": "<string>",
  "prev": "<string>",
  "count": 1,
  "items": [
    {
      "id": 2,
      "name": "<string>",
      "code": "<string>",
      "client": {
        "id": 123,
        "name": "<string>",
        "code": "<string>",
        "externalCode": null
      },
      "owner": null,
      "status": "draft",
      "contractType": "nonBillable",
      "startsOn": null,
      "createdAt": "2023-11-07T05:31:56Z",
      "lastModifiedAt": "2023-11-07T05:31:56Z",
      "price": null,
      "authorizedActions": [
        "canEditAndDelete"
      ],
      "organizationId": 2,
      "description": "",
      "initialDeliveryDate": null,
      "revisedDeliveryDate": null,
      "launchedAt": null,
      "lastChargedOn": null,
      "standardRateCard": {
        "id": 2,
        "name": "<string>"
      },
      "initialTimeEstimate": null,
      "revisedTimeEstimate": null,
      "standardRate": null,
      "billRate": null,
      "initialBudget": null,
      "revisedBudget": null,
      "discount": null,
      "discountRate": null,
      "estimatedOverrun": null,
      "initialRecoveryRate": null,
      "estimatedRecoveryRate": null,
      "totalInvoiced": null,
      "risks": [
        {
          "type": "budgetOverRun",
          "label": "<string>"
        }
      ],
      "anomalies": [
        {
          "type": "noServices",
          "label": "<string>"
        }
      ],
      "invoicingWarnings": [
        {
          "type": "unapprovedItems",
          "applicableFrom": "2021-07-22",
          "preventsInvoicing": true,
          "label": "<string>"
        }
      ]
    }
  ]
}

Headers

​
Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

​
organizationId
integer
required

Filter on a single organization unique identifier.

​
search
string[]

Comma-separated list of codes / names to search for

​
limit
integer
default:10

Page size

​
page
integer
default:1

Page number

Required range: x >= 1
​
fields.root
enum<string>

Return total items count (across all pages).

Available options:
count
​
code
string

Only returns projects whose code is strictly equal to sent value

Response

200
application/json

OK

The response is of type object.