Skip to main content
GET
List projects

Authorizations

X-API-KEY
string
header
required

Query Parameters

search
string | null
id
integer[] | null
status
enum<string>[] | null
Available options:
active,
archived
status_extended
enum<string>[] | null
Available options:
planning,
active,
on_hold,
completed,
closed,
archived
customer_id
integer[] | null
record_status
enum<string>[] | null
Available options:
draft,
posted,
archived
billing_method
enum<string>[] | null
Available options:
fixed_fee,
time_and_materials,
milestone
billing_type
enum<string>[] | null
Available options:
time_and_materials,
fixed_fee,
non_billable
project_manager_id
integer[] | null
start_date_gte
string<date> | null
start_date_lte
string<date> | null
end_date_gte
string<date> | null
end_date_lte
string<date> | null
ordering
string | null
default:id
limit
integer
default:100

Number of records to return per page (capped at 100)

Required range: x >= 1
offset
integer
default:0

Number of records to skip before starting to return results

Required range: x >= 0

Response

200 - application/json

OK

items
ProjectListSchemaOut · object[]
required
count
integer
required