API Reference
GuidesAPI ReferenceSign In
  • Introduction
  • Authentication
  • Scopes
  • Errors
  • Endpoints
    • Accounts & Transactions
    • Customers & Suppliers
    • Expenses
    • Income
    • Payments
    • Products & Services
    • Projects
    • Tags
    • Taxes
  • Common Models
    • Countries
    • Currencies
Powered by GitBook
On this page
  1. Endpoints

Projects

All API Operations related with projects

PreviousProducts & ServicesNextTags

Last updated 9 months ago

READ Scope

WRITE Scope

UPDATE Scope

List all Projects

get

Retrieves all the projects

Authorizations
Responses
200
OK
application/json
get
GET /v1/project HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "budget": 1,
      "startDate": "text",
      "endDate": "text",
      "code": "text"
    }
  ]
}

Get a Project by ID

get

Retrieves a single product or service by its unique ID or user-generated project code.

Authorizations
Path parameters
idstringRequired
Responses
200
OK
application/json
get
GET /v1/project/{id} HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "budget": 1,
    "startDate": "text",
    "endDate": "text",
    "code": "text"
  }
}
  • READ Scope
  • GETList all Projects
  • GETGet a Project by ID
  • WRITE Scope
  • POSTCreate a new Project
  • UPDATE Scope
  • PUTUpdate Project

Create a new Project

post

Creates a new project

Authorizations
Body
all ofOptional
Responses
200
OK
application/json
post
POST /v1/project HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "name": "text",
  "startDate": "text",
  "endDate": "text",
  "projectCode": "text",
  "budget": 1
}
200

OK

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "budget": 1,
    "startDate": "text",
    "endDate": "text"
  }
}

Update Project

put

Updates an existing project

Authorizations
Path parameters
idstring ยท uuidRequired
Body
all ofOptional
Responses
200
OK
application/json
put
PUT /v1/project/{id} HTTP/1.1
Host: api.nuvio.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "name": "text",
  "startDate": "text",
  "endDate": "text",
  "projectCode": "text",
  "budget": 1
}
200

OK

{
  "success": true,
  "errors": [
    "text"
  ],
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "budget": 1,
    "startDate": "text",
    "endDate": "text"
  }
}