Get All Projects
You can use this endpoint to call up a paginated list of all projects.
Request
GET /api/v1/projects
curl --request GET \
--url 'https://www.zep-online.de/zepinstanz/next/api/v1/projects' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {token}'
Response
{
"data": [
{
"id": 2,
"name": "dolor omnis sint",
"description": "Voluptatem magnam quas molestiae aut.",
"start_date": "2024-03-01T00:00:00.000000Z",
"end_date": "2024-04-06T00:00:00.000000Z",
"project_status_id": "aktiv",
"status": {
"id": "gesperrt",
"name": "gesperrt",
"description": "Est ipsum ullam facilis illum quasi molestiae.",
"bookable": false,
"order": 0,
"color": "#FF0000"
},
"comments": null,
"cost_object": null,
"cost_object_identifier": null,
"created": "2024-03-25T11:10:43.000000Z",
"modified": "2024-03-25T11:10:43.000000Z",
"keywords": [
"modi",
"voluptatum",
"id"
],
"reference_order": null,
"reference_commission": null,
"reference_procurement": null,
"reference_object": null,
"language": null,
"currency": null,
"url": null,
"location_address": null,
"location_city": null,
"location_state": null,
"location_country": null,
"revenue_account": null,
"customer_id": null,
"customer_contact_id": null,
"customer_project_reference": null,
"customer_billing_address_id": null,
"customer_shipping_address_id": null,
"has_multiple_customers": null,
"department_id": 0,
"billing_type": null,
"billing_tasks": null,
"plan_hours": null,
"plan_hours_children": "96.0000000000",
"plan_hours_per_day": null,
"plan_can_exceed": false,
"plan_warning_percent": null,
"plan_warning_percent_2": null,
"plan_warning_percent_3": null,
"plan_wage": null,
"plan_expenses": null,
"plan_expenses_travel": null,
"plan_hours_done": "8.7500000000",
"plan_hours_invoiced": "8.7500000000",
"categories_count": 1,
"dynamicAttributes_count": 1,
"tasks_count": 5,
"employees_count": 1,
"activities_count": 5
},
{
"id": 3,
// ...
}
]
}
Optional Parameters
- Name
start_date
- Type
- date | Y-m-d
- Description
First day of the period to be queried. It is inclusive, so the day specified as start_date will also be considered on the results
- Name
end_date
- Type
- date | Y-m-d
- Description
Last day of the period to be queried. It is inclusive, so the day specified as end_date will also be considered on the results.
- Name
id | id[]
- Type
- string | array of strings
- Description
A single customer number or a list of customer numbers to filter the results.
- Name
name
- Type
- string
- Description
Project name for filtering the results.
- Name
status
- Type
- string
- Description
Project status for filtering the results.
- Name
limit
- Type
- integer
- Description
Attribute for limiting the number of entries per page