Projects
-
Return all of the user's projects
GET /api/1/projects.jsonFormats
json jsonpReturns an array of project objects belonging to authenticated user. Can take a URL-encoded, SQL-like query string and order string which can help filter and order the results that will be returned. So the query string:
name ~= "quia+itaque"which lookes like this when URL encoded:
/api/1/projects.json?where=name~%3D"quia+itaque"&order=name+ascwill return all projects similar to “quia itaque” ordered by name in ascending order.
Click here for more information on the API query string.
Errors
- 401 Unauthorized
- 403 Read Denied - if the user is not allowed to read projects
- 404 Record Not Found - returned if the company with the specified UUID is not found
Example
GET /api/1/projects 200 { "response": [ { "active": "true", "company_uuid": "935956d8-a094-4948-ac47-d84d10a62eff", "default_tags": null, "hourly_rate": null, "hourly_rate_cents": null, "name": "commodi deserunt", "notes": null, "time_limit": null, "time_limit_string": null, "uuid": "7dcb0cdb-ea5a-4b36-ae46-6ad3f0d33fcc", "visibility": "private", "activities": [ { "name": "asperiores libero", "project_uuid": "7dcb0cdb-ea5a-4b36-ae46-6ad3f0d33fcc", "uuid": "d6d29e0f-9aeb-4258-b052-4df954a864d6" } ], "grand_total": 0 }, { "active": "true", "company_uuid": "935956d8-a094-4948-ac47-d84d10a62eff", "default_tags": null, "hourly_rate": null, "hourly_rate_cents": null, "name": "repellendus cumque", "notes": null, "time_limit": null, "time_limit_string": null, "uuid": "750c6db7-21f8-411f-91e1-f52ac5d755a8", "visibility": "private", "activities": [], "grand_total": 0 }, { "active": "true", "company_uuid": "935956d8-a094-4948-ac47-d84d10a62eff", "default_tags": null, "hourly_rate": null, "hourly_rate_cents": null, "name": "velit excepturi", "notes": null, "time_limit": null, "time_limit_string": null, "uuid": "d030294e-8ea0-472b-b77e-da7288227b3d", "visibility": "private", "activities": [ { "name": "praesentium quis", "project_uuid": "d030294e-8ea0-472b-b77e-da7288227b3d", "uuid": "51e3bfc1-f32a-4209-a74f-c9ee0fc72aab" }, { "name": "quia delectus", "project_uuid": "d030294e-8ea0-472b-b77e-da7288227b3d", "uuid": "92cbc8b4-f26d-4cba-8dd8-3a23f6902b2b" } ], "grand_total": 0 } ], "count": 3 }Parameters
-
where
An SQL-like query string which can filter the results that will be returned
Optional Must be String -
order
An SQL-like order string, that sets the order of the returned objects
Optional Must be String
Return all of the user's projects belonging to a company
GET /api/1/companies/:company_uuid/projects.jsonFormats
json jsonpReturns an array of project objects belonging to authenticated user. Can take a URL-encoded, SQL-like query string and order string which can help filter and order the results that will be returned. So the query string:
name ~= "quia+itaque"which lookes like this when URL encoded:
/api/1/projects.json?where=name~%3D"quia+itaque"&order=name+ascwill return all projects similar to “quia itaque” ordered by name in ascending order.
Click here for more information on the API query string.
Errors
- 401 Unauthorized
- 403 Read Denied - if the user is not allowed to read projects
- 404 Record Not Found - returned if the company with the specified UUID is not found
Example
GET /api/1/projects 200 { "response": [ { "active": "true", "company_uuid": "935956d8-a094-4948-ac47-d84d10a62eff", "default_tags": null, "hourly_rate": null, "hourly_rate_cents": null, "name": "commodi deserunt", "notes": null, "time_limit": null, "time_limit_string": null, "uuid": "7dcb0cdb-ea5a-4b36-ae46-6ad3f0d33fcc", "visibility": "private", "activities": [ { "name": "asperiores libero", "project_uuid": "7dcb0cdb-ea5a-4b36-ae46-6ad3f0d33fcc", "uuid": "d6d29e0f-9aeb-4258-b052-4df954a864d6" } ], "grand_total": 0 }, { "active": "true", "company_uuid": "935956d8-a094-4948-ac47-d84d10a62eff", "default_tags": null, "hourly_rate": null, "hourly_rate_cents": null, "name": "repellendus cumque", "notes": null, "time_limit": null, "time_limit_string": null, "uuid": "750c6db7-21f8-411f-91e1-f52ac5d755a8", "visibility": "private", "activities": [], "grand_total": 0 }, { "active": "true", "company_uuid": "935956d8-a094-4948-ac47-d84d10a62eff", "default_tags": null, "hourly_rate": null, "hourly_rate_cents": null, "name": "velit excepturi", "notes": null, "time_limit": null, "time_limit_string": null, "uuid": "d030294e-8ea0-472b-b77e-da7288227b3d", "visibility": "private", "activities": [ { "name": "praesentium quis", "project_uuid": "d030294e-8ea0-472b-b77e-da7288227b3d", "uuid": "51e3bfc1-f32a-4209-a74f-c9ee0fc72aab" }, { "name": "quia delectus", "project_uuid": "d030294e-8ea0-472b-b77e-da7288227b3d", "uuid": "92cbc8b4-f26d-4cba-8dd8-3a23f6902b2b" } ], "grand_total": 0 } ], "count": 3 }Parameters
-
where
An SQL-like query string which can filter the results that will be returned
Optional Must be String -
order
An SQL-like order string, that sets the order of the returned objects
Optional Must be String