Listing, Sorting and Filtering Projects
This endpoint returns the list of projects.
Sorting
The results from this endpoint can be ordered using the $orderby query parameter. Specify a field name, and optionally asc or desc.
Sorting is valid on the following fields: name, isActive, assignedPaymentMethodId, locationId
Filtering
There are two ways to filter the set of returned projects from this endpoint - the first is to use the $filter query parameter, the second is to use the
$label_key and $label query parameters.
$filter allows for projects to be filtered on the basis of fields in the schema using OData query syntax.
See this document for more details on the syntax used.
Filters are valid on the following fields: name, isActive, assignedPaymentMethodId, locationId
Examples:
?$top=10 - Returns only the first 10 projects from the list.
?$orderby=name desc - Sorts projects by name in descending order.
?$filter=name eq 'descriptive name' - Returns projects that match the provided name.
?$orderby=properties/created desc - Sorts projects by creation date in descending order.
?$filter=properties/created ge 2021-01-01T00:00:00Z - Returns projects created after January 1, 2021.