List Project (find where)
Find a list of Project records that match the specified criteria.
Tip: All query parameters accept multiple values for array filtering — e.g. ?id=1&id=2 or ?id[]=1&id[]=2. This also works within the where parameter: ?where={"id":[1,2,3]}.
Note: The per-attribute filter parameters and the where parameter are mutually exclusive. If where is supplied, the per-attribute filters are ignored — put all filter criteria inside where instead. limit, skip, sort, and populate are unaffected.
query Parameters
statusFilter by status (1 = active, 0 = inactive)
clientID of the associated Client record
isSuperProjectWhen true, this project is a container for sub-projects. Sub-projects inherit color and client from the parent.
projectParentID of the associated Project record. The super project this sub-project belongs to.
nameFilter by name
idFilter by record ID
createdAtFilter by creation date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.sssZ). This is an exact match filter; for range queries (greater than, less than), use the where parameter instead
updatedAtFilter by last update date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.sssZ). This is an exact match filter; for range queries (greater than, less than), use the where parameter instead
whereA JSON-encoded Waterline criteria for advanced filtering. Only whitelisted criteria are supported: status, client, isSuperProject, projectParent, name, id, createdAt, updatedAt. Sub-attribute modifiers such as startsWith, >=, <=, >, <, and != are supported on any whitelisted criterion. The contains modifier is only supported on: name.
Note: If where is supplied, the per-attribute filter query parameters above are ignored — where is the entire criteria. (limit, skip, sort, and populate are unaffected.) To combine filters, put them all inside where.
e.g. ?where={"startDate":{">=":"2026-06-01","<":"2026-07-01"}}
limitThe maximum number of records to return. Defaults to 10000, capped at 50000.
skipThe number of records to skip (useful for pagination).
sortThe sort order. By default, returned records are sorted by primary key value in ascending order.
e.g. ?sort=lastName%20ASC
List Project (find where) › Responses
Responds with a paged list of Project records that match the specified criteria
Get Project (find one)
Update Project
Partially update an existing Project record. Despite using PUT, this endpoint applies PATCH semantics — only the fields included in the request body are modified; omitted fields are left unchanged.
path Parameters
idThe desired Project record's primary key value
Update Project › Request Body
Aerion model Project
Update Project › Responses
Responds with the newly updated Project record as a JSON dictionary
Aerion model Project
Get Project history log
Returns the history log for a Project record. Each entry contains oldState and newState objects with only the fields that changed between revisions. Fields may be further omitted based on the requesting user's permissions.
query Parameters
idThe ID of the Project record to retrieve history for
Get Project history log › Responses
Successful operation