API Reference
Projects API
Create, list, retrieve, update, and delete projects programmatically.
GET
/projects
List projects
Returns all projects in your organization, sorted by newest first.
| Parameter | Type | Description |
|---|---|---|
page |
number, optional | Page number. Defaults to 1. |
per_page |
number, optional | Results per page. Defaults to 25, maximum 100. |
Returns
A projects array and a pagination meta object.
Endpoint
https://api.nicedata.ai/v1/projects
Example request
curl https://api.nicedata.ai/v1/projects
-H "Authorization: Bearer nd_live_abc123..."
Example response
{
"projects": [
{
"id": "019d1234-abcd-7890-ef01-234567890abc",
"name": "Receipts",
"email": "[email protected]",
"email_parse_option": "both",
"retention_days": 60,
"documents_count": 8,
"created_at": "2026-03-25T14:30:00Z"
}
],
"meta": {
"page": 1,
"per_page": 25,
"total": 1,
"total_pages": 1
}
}
GET
/projects/{project_id}
Retrieve project
Returns a single project by ID.
No request parameters.
Returns
A project object.
Endpoint
https://api.nicedata.ai/v1/projects/{project_id}
Example request
curl https://api.nicedata.ai/v1/projects/019d1234-abcd-7890-ef01-234567890abc
-H "Authorization: Bearer nd_live_abc123..."
Example response
{
"project": {
"id": "019d1234-abcd-7890-ef01-234567890abc",
"name": "Receipts",
"email": "[email protected]",
"email_parse_option": "both",
"retention_days": 60,
"documents_count": 8,
"created_at": "2026-03-25T14:30:00Z"
}
}
POST
/projects
Create project
Creates a new project in your organization.
| Parameter | Type | Description |
|---|---|---|
project.name |
string, required | Project name. 1 to 100 characters and unique within your organization. |
Returns
The newly created project object.
Endpoint
https://api.nicedata.ai/v1/projects
Example request
curl https://api.nicedata.ai/v1/projects \
-X POST \
-H "Authorization: Bearer nd_live_abc123..." \
-H "Content-Type: application/json" \
-d '{"project":{"name":"Invoices"}}'
Example response
{
"project": {
"id": "019d1234-abcd-7890-ef01-234567890abc",
"name": "Invoices",
"email": "[email protected]",
"email_parse_option": "both",
"retention_days": 60,
"documents_count": 0,
"created_at": "2026-03-25T14:30:00Z"
}
}
PATCH
/projects/{project_id}
Update project
Updates a project's name.
| Parameter | Type | Description |
|---|---|---|
project.name |
string, required | New project name. 1 to 100 characters and unique within your organization. |
Returns
The updated project object.
Endpoint
https://api.nicedata.ai/v1/projects/{project_id}
Example request
curl https://api.nicedata.ai/v1/projects/019d1234-abcd-7890-ef01-234567890abc \
-X PATCH \
-H "Authorization: Bearer nd_live_abc123..." \
-H "Content-Type: application/json" \
-d '{"project":{"name":"Invoices Q4"}}'
Example response
{
"project": {
"id": "019d1234-abcd-7890-ef01-234567890abc",
"name": "Invoices Q4",
"email": "[email protected]",
"email_parse_option": "both",
"retention_days": 60,
"documents_count": 8,
"created_at": "2026-03-25T14:30:00Z"
}
}
DELETE
/projects/{project_id}
Delete project
Permanently deletes the project, its documents, webhook records, activity, runs, exports, and stored files.
No request parameters.
Returns
No content.
Endpoint
https://api.nicedata.ai/v1/projects/{project_id}
Example request
curl https://api.nicedata.ai/v1/projects/019d1234-abcd-7890-ef01-234567890abc \
-X DELETE \
-H "Authorization: Bearer nd_live_abc123..."
Example response
204 No Content