Skip to Content
Z8Z8 Docs

List projects

GET
/api/v1/projects

The organization's projects with their status and customer. Budgets, rates and members are never returned.

Each project carries its custom field values as of asOf in customFields, keyed by field id; GET /api/v1/projects/custom-fields describes the fields.

Requires the key scope projects:read.

Authorization

apiKey
headerAuthorizationBearer <token>

An organization API key (starts with z8_org).

Query Parameters

limit?integer

Rows per page, 1 to 200.

Range1 <= value <= 200
Default50
cursor?string

The nextCursor of the previous page. Omit it for the first page.

Length1 <= length <= 1024
status?string

Only projects with this status. All by default.

Value in"planned""active""paused""completed""archived"
customerId?string

Only the projects of this customer.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
asOf?string

The date custom field values are read as of, YYYY-MM-DD. Today in the organization's timezone by default. A tracked field returns the value valid on this date; an untracked field its only value.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate

Response Body

OK

application/json
  1. response
data*array<>
nextCursor*|

Pass as cursor to read the next page; null on the last page.

asOf*string

The date the customFields values were read as of.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
Example Request
curl -X GET 'https://ui.z8-time.app/api/v1/projects'
Example Response
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "status": "planned",      "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",      "customFields": {        "property1": "string",        "property2": "string"      }    }  ],  "nextCursor": "string",  "asOf": "2019-08-24"}