Skip to main content
GET
/
v1
/
projects
/
{id}
Get project by ID
curl --request GET \
  --url https://api.nomi.tools/v1/projects/{id} \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "<string>",
  "projectCategoryId": "<string>",
  "name": "<string>",
  "notes": "<string>",
  "hasPlan": true,
  "planIncome": 123,
  "planOutcome": 123,
  "income": 123,
  "outcome": 123,
  "grossProfit": 123,
  "profitability": 123,
  "isArchived": true,
  "planGrossProfit": 123,
  "planProfitability": 123
}

Authorizations

Authorization
string
header
required

Use HTTP Basic Authentication. Provide your email as login and PPT token as the password.

Headers

Accept
enum<string>
default:application/json
required
Available options:
application/json

Path Parameters

id
string
required

Response

Project details

id
string

Unique identifier for the project.

projectCategoryId
string | null

Identifier for the project category.

name
string

Name of the project.

notes
string | null

Additional notes about the project.

hasPlan
boolean

Indicates if the project has a plan.

planIncome
number<float> | null

Planned income for the project.

planOutcome
number<float> | null

Planned outcome for the project.

income
number<float>

Actual income for the project.

outcome
number<float>

Actual outcome for the project.

grossProfit
number<float>

Actual gross profit for the project.

profitability
number<float>

Actual profitability percentage.

isArchived
boolean

Indicates if the project is archived.

planGrossProfit
number<float> | null

Planned gross profit for the project.

planProfitability
number<float> | null

Planned profitability percentage.