Projects

All API Operations related with projects

READ Scope

List all Projects

Retrieves all the projects

get

/v1/project

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.nuvio.io/v1/project' \
  --header 'Authorization: YOUR_API_KEY'

200

200

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

OK

Get a Project by ID

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

get

/v1/project/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.nuvio.io/v1/project/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

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

OK

WRITE Scope

Create a new Project

Creates a new project

post

/v1/project

Authorizations

Body

application/jsontext/jsonapplication/*+json

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.nuvio.io/v1/project' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "startDate": "text",
    "endDate": "text",
    "projectCode": "text",
    "budget": 1
  }'

200

200

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

OK

UPDATE Scope

Update Project

Updates an existing project

put

/v1/project/{id}

Authorizations

Path parameters

idstring · uuidrequired

Body

application/jsontext/jsonapplication/*+json

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.nuvio.io/v1/project/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "startDate": "text",
    "endDate": "text",
    "projectCode": "text",
    "budget": 1
  }'

200

200

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

OK