List projects

GET/api/v1/projects

List projects, optionally filtered by status or customer.

Operation ID: list_projects_api_v1_projects_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

statusstring: Filter by status: active, completed, on_hold.
customer_idstring: Filter by customer.
include_inactivebooleandefault: False

Responses

200Successful Response

Schema: ProjectsListResponse

itemsarray · ProjectResponserequiredProjectResponse

13 fields

idstringrequired
business_idstringrequired
namestringrequired
codestring
descriptionstring
statusstringrequired
customer_idstring
customer_namestring
start_datestring · date
end_datestring · date
is_activebooleanrequired
created_atstring · date-timerequired
updated_atstring · date-timerequired

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/projects

bash

curl -X GET 'https://api.ondayzero.com/api/v1/projects' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'