Skip to main content
GET
/
projects
/
{project_id}
Get project details
curl --request GET \
  --url https://{your-workspace}.neetoinvoice.com/api/external/v1/projects/{project_id} \
  --header 'X-Api-Key: <x-api-key>'
{
  "project": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "identifier": "<string>",
    "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "internal_notes": "<string>",
    "name": "<string>",
    "hourly_rate": 123,
    "flat_amount": 123,
    "status": "<string>",
    "flat_amount_with_currency": "<string>",
    "hourly_rate_with_currency": "<string>",
    "creator_name": "<string>",
    "currency": "<string>",
    "client": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "identifier": "<string>",
      "internal_notes": "<string>",
      "currency": "<string>",
      "status": "<string>"
    },
    "billing_method": "<string>",
    "fixed_price_project": true,
    "hourly_person_rate": true,
    "hourly_task_rate": true,
    "hourly_project_rate": true,
    "currency_symbol": "<string>",
    "recurring_invoice": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "enabled": true,
      "first_issue_date": "2023-12-25",
      "frequency": 123,
      "frequency_type": "<string>",
      "time_to_send": "<string>",
      "timezone": "<string>",
      "interval": "<string>"
    },
    "invoice_count": 123
  },
  "tasks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "hourly_rate": 123,
      "deleted": true,
      "hourly_rate_with_currency": "<string>",
      "is_billable": true
    }
  ],
  "checklists": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "task_name": "<string>",
      "items": [
        "<string>"
      ],
      "required": [
        true
      ]
    }
  ]
}
Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Path Parameters

project_id
string
required

Unique ID of the project for which you want to retrieve or update details. Refer to Getting the Project ID section for detailed instructions.

Response

200 - application/json

OK - Project details retrieved successfully

project
object
tasks
object[]
checklists
object[]