Documentation

Files

Organization Structure API

Core HR API

Cleemy Expenses API

Cleemy Invoices API

Timmi Absences API

Timmi Office API

Timmi Project API

Timmi Settings API

Timmi Timesheet API

Pagga Mealvouchers API

Pagga Remuneration API

Poplee Training API

Projects

List Projects

List projects from an organization. Only returns a subset of a Project fields.

Search

The search query parameter takes a list of words and enables you to only return projects whose code or name (or those of their clients) contains all those words.

GET /api/v4/projects?organizationId=1&search=pro,avat&fields.root=count HTP/1.1

{
  "count": 2,
  "items": [
    {
      "id": 1,
      "name": "Project",
      "code": "Avatar",
      "client": {
        "name": "James Cameron",
        "code": "CAMERON"
      }
    },
    {
      "id": 2,
      "name": "Avatar Project",
      "code": "Awesomeness",
      "client": {
        "name": "Advent",
        "code": "ADVENT"
      }
  ],
  {
    "id": 3,
    "name": "Test",
    "code": "Test",
    "client": {
      "name": "Avatar",
      "code": "project"
    }
  }
}

GET

timmi-project

api

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.

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

The response is of type object.

The project resource

Create a new Project

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>"
        }
      ]
    }
  ]
}