Optional refresh token to invalidate immediately. Example: abc123def456
Endpoints for managing projects.
+ ++requires authentication +
+ + + + +Example request:+ + +
curl --request GET \
+ --get "http://localhost/api/projects/types" \
+ --header "Content-Type: application/json" \
+ --header "Accept: application/json"const url = new URL(
+ "http://localhost/api/projects/types"
+);
+
+const headers = {
+ "Content-Type": "application/json",
+ "Accept": "application/json",
+};
+
+fetch(url, {
+ method: "GET",
+ headers,
+}).then(response => response.json());++Example response (200):
+
+
+[
+ {
+ "id": 1,
+ "name": "Project"
+ },
+ {
+ "id": 2,
+ "name": "Support"
+ },
+ {
+ "id": 3,
+ "name": "Engagement"
+ }
+]
+
+
+
+ Received response: ++
Request failed with error:+
+
+Tip: Check that you're properly connected to the network.
+If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
+You can check the Dev Tools console for debugging information.+requires authentication +
+ + + + +Example request:+ + +
curl --request GET \
+ --get "http://localhost/api/projects/statuses" \
+ --header "Content-Type: application/json" \
+ --header "Accept: application/json"const url = new URL(
+ "http://localhost/api/projects/statuses"
+);
+
+const headers = {
+ "Content-Type": "application/json",
+ "Accept": "application/json",
+};
+
+fetch(url, {
+ method: "GET",
+ headers,
+}).then(response => response.json());++Example response (200):
+
+
+[
+ {
+ "id": 1,
+ "name": "Pre-sales",
+ "order": 1
+ },
+ {
+ "id": 2,
+ "name": "SOW Approval",
+ "order": 2
+ },
+ {
+ "id": 3,
+ "name": "Gathering Estimates",
+ "order": 3
+ }
+]
+
+
+
+ Received response: ++
Request failed with error:+
+
+Tip: Check that you're properly connected to the network.
+If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
+You can check the Dev Tools console for debugging information.+requires authentication +
+ +Get a list of all projects with optional filtering by status and type.
+ + +Example request:+ + +
curl --request GET \
+ --get "http://localhost/api/projects?status_id=1&type_id=2" \
+ --header "Content-Type: application/json" \
+ --header "Accept: application/json"const url = new URL(
+ "http://localhost/api/projects"
+);
+
+const params = {
+ "status_id": "1",
+ "type_id": "2",
+};
+Object.keys(params)
+ .forEach(key => url.searchParams.append(key, params[key]));
+
+const headers = {
+ "Content-Type": "application/json",
+ "Accept": "application/json",
+};
+
+fetch(url, {
+ method: "GET",
+ headers,
+}).then(response => response.json());++Example response (200):
+
+
+[
+ {
+ "id": "550e8400-e29b-41d4-a716-446655440000",
+ "code": "PROJ-001",
+ "title": "Client Dashboard Redesign",
+ "status_id": 1,
+ "status": {
+ "id": 1,
+ "name": "Pre-sales"
+ },
+ "type_id": 2,
+ "type": {
+ "id": 2,
+ "name": "Support"
+ },
+ "approved_estimate": "120.00",
+ "forecasted_effort": {
+ "2024-02": 40,
+ "2024-03": 60,
+ "2024-04": 20
+ },
+ "created_at": "2024-01-15T10:00:00.000000Z",
+ "updated_at": "2024-01-15T10:00:00.000000Z"
+ }
+]
+
+
+
+ Received response: ++
Request failed with error:+
+
+Tip: Check that you're properly connected to the network.
+If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
+You can check the Dev Tools console for debugging information.+requires authentication +
+ +Create a new project with code, title, and type.
+ + +Example request:+ + +
curl --request POST \
+ "http://localhost/api/projects" \
+ --header "Content-Type: application/json" \
+ --header "Accept: application/json" \
+ --data "{
+ \"code\": \"PROJ-001\",
+ \"title\": \"Client Dashboard Redesign\",
+ \"type_id\": 1
+}"
+const url = new URL(
+ "http://localhost/api/projects"
+);
+
+const headers = {
+ "Content-Type": "application/json",
+ "Accept": "application/json",
+};
+
+let body = {
+ "code": "PROJ-001",
+ "title": "Client Dashboard Redesign",
+ "type_id": 1
+};
+
+fetch(url, {
+ method: "POST",
+ headers,
+ body: JSON.stringify(body),
+}).then(response => response.json());++Example response (201):
+
+
+{
+ "id": "550e8400-e29b-41d4-a716-446655440000",
+ "code": "PROJ-001",
+ "title": "Client Dashboard Redesign",
+ "status_id": 1,
+ "status": {
+ "id": 1,
+ "name": "Pre-sales"
+ },
+ "type_id": 1,
+ "type": {
+ "id": 1,
+ "name": "Project"
+ }
+}
+
+ ++Example response (422):
+
+
+{
+ "message": "Validation failed",
+ "errors": {
+ "code": [
+ "Project code must be unique"
+ ],
+ "title": [
+ "The title field is required."
+ ]
+ }
+}
+
+
+
+ Received response: ++
Request failed with error:+
+
+Tip: Check that you're properly connected to the network.
+If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
+You can check the Dev Tools console for debugging information.+requires authentication +
+ +Get details of a specific project by ID.
+ + +Example request:+ + +
curl --request GET \
+ --get "http://localhost/api/projects/550e8400-e29b-41d4-a716-446655440000" \
+ --header "Content-Type: application/json" \
+ --header "Accept: application/json"const url = new URL(
+ "http://localhost/api/projects/550e8400-e29b-41d4-a716-446655440000"
+);
+
+const headers = {
+ "Content-Type": "application/json",
+ "Accept": "application/json",
+};
+
+fetch(url, {
+ method: "GET",
+ headers,
+}).then(response => response.json());++Example response (200):
+
+
+{
+ "id": "550e8400-e29b-41d4-a716-446655440000",
+ "code": "PROJ-001",
+ "title": "Client Dashboard Redesign",
+ "status": {
+ "id": 1,
+ "name": "Pre-sales"
+ },
+ "type": {
+ "id": 1,
+ "name": "Project"
+ },
+ "approved_estimate": "120.00",
+ "forecasted_effort": {
+ "2024-02": 40,
+ "2024-03": 60
+ }
+}
+
+ ++Example response (404):
+
+
+{
+ "message": "Project not found"
+}
+
+
+
+ Received response: ++
Request failed with error:+
+
+Tip: Check that you're properly connected to the network.
+If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
+You can check the Dev Tools console for debugging information.+requires authentication +
+ +Update details of an existing project.
+ + +Example request:+ + +
curl --request PUT \
+ "http://localhost/api/projects/550e8400-e29b-41d4-a716-446655440000" \
+ --header "Content-Type: application/json" \
+ --header "Accept: application/json" \
+ --data "{
+ \"code\": \"PROJ-002\",
+ \"title\": \"Updated Title\",
+ \"type_id\": 2
+}"
+const url = new URL(
+ "http://localhost/api/projects/550e8400-e29b-41d4-a716-446655440000"
+);
+
+const headers = {
+ "Content-Type": "application/json",
+ "Accept": "application/json",
+};
+
+let body = {
+ "code": "PROJ-002",
+ "title": "Updated Title",
+ "type_id": 2
+};
+
+fetch(url, {
+ method: "PUT",
+ headers,
+ body: JSON.stringify(body),
+}).then(response => response.json());++Example response (200):
+
+
+{
+ "id": "550e8400-e29b-41d4-a716-446655440000",
+ "code": "PROJ-002",
+ "title": "Updated Title",
+ "type_id": 2
+}
+
+ ++Example response (404):
+
+
+{
+ "message": "Project not found"
+}
+
+ ++Example response (422):
+
+
+{
+ "message": "Validation failed",
+ "errors": {
+ "type_id": [
+ "The selected type id is invalid."
+ ]
+ }
+}
+
+
+
+ Received response: ++
Request failed with error:+
+
+Tip: Check that you're properly connected to the network.
+If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
+You can check the Dev Tools console for debugging information.+requires authentication +
+ +Delete a project. Cannot delete if project has allocations or actuals.
+ + +Example request:+ + +
curl --request DELETE \
+ "http://localhost/api/projects/550e8400-e29b-41d4-a716-446655440000" \
+ --header "Content-Type: application/json" \
+ --header "Accept: application/json"const url = new URL(
+ "http://localhost/api/projects/550e8400-e29b-41d4-a716-446655440000"
+);
+
+const headers = {
+ "Content-Type": "application/json",
+ "Accept": "application/json",
+};
+
+fetch(url, {
+ method: "DELETE",
+ headers,
+}).then(response => response.json());++Example response (200):
+
+
+{
+ "message": "Project deleted successfully"
+}
+
+ ++Example response (404):
+
+
+{
+ "message": "Project not found"
+}
+
+ ++Example response (422):
+
+
+{
+ "message": "Cannot delete project with allocations"
+}
+
+
+
+ Received response: ++
Request failed with error:+
+
+Tip: Check that you're properly connected to the network.
+If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
+You can check the Dev Tools console for debugging information.+requires authentication +
+ +Transition project to a new status following the state machine rules.
+ + +Example request:+ + +
curl --request PUT \
+ "http://localhost/api/projects/architecto/status" \
+ --header "Content-Type: application/json" \
+ --header "Accept: application/json" \
+ --data "{
+ \"status_id\": 2
+}"
+const url = new URL(
+ "http://localhost/api/projects/architecto/status"
+);
+
+const headers = {
+ "Content-Type": "application/json",
+ "Accept": "application/json",
+};
+
+let body = {
+ "status_id": 2
+};
+
+fetch(url, {
+ method: "PUT",
+ headers,
+ body: JSON.stringify(body),
+}).then(response => response.json());++Example response (200):
+
+
+{
+ "id": "550e8400-e29b-41d4-a716-446655440000",
+ "status": {
+ "id": 2,
+ "name": "SOW Approval"
+ }
+}
+
+ ++Example response (404):
+
+
+{
+ "message": "Project not found"
+}
+
+ ++Example response (422):
+
+
+{
+ "message": "Cannot transition from Pre-sales to Done"
+}
+
+
+
+ Received response: ++
Request failed with error:+
+
+Tip: Check that you're properly connected to the network.
+If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
+You can check the Dev Tools console for debugging information.+requires authentication +
+ +Set the approved billable hours estimate for a project.
+ + +Example request:+ + +
curl --request PUT \
+ "http://localhost/api/projects/architecto/estimate" \
+ --header "Content-Type: application/json" \
+ --header "Accept: application/json" \
+ --data "{
+ \"approved_estimate\": 120
+}"
+const url = new URL(
+ "http://localhost/api/projects/architecto/estimate"
+);
+
+const headers = {
+ "Content-Type": "application/json",
+ "Accept": "application/json",
+};
+
+let body = {
+ "approved_estimate": 120
+};
+
+fetch(url, {
+ method: "PUT",
+ headers,
+ body: JSON.stringify(body),
+}).then(response => response.json());++Example response (200):
+
+
+{
+ "id": "550e8400-e29b-41d4-a716-446655440000",
+ "approved_estimate": "120.00"
+}
+
+ ++Example response (404):
+
+
+{
+ "message": "Project not found"
+}
+
+ ++Example response (422):
+
+
+{
+ "message": "Approved estimate must be greater than 0"
+}
+
+
+
+ Received response: ++
Request failed with error:+
+
+Tip: Check that you're properly connected to the network.
+If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
+You can check the Dev Tools console for debugging information.+requires authentication +
+ +Set the month-by-month forecasted effort breakdown.
+ + +Example request:+ + +
curl --request PUT \
+ "http://localhost/api/projects/architecto/forecast" \
+ --header "Content-Type: application/json" \
+ --header "Accept: application/json" \
+ --data "{
+ \"forecasted_effort\": {
+ \"2024-02\": 40,
+ \"2024-03\": 60
+ }
+}"
+const url = new URL(
+ "http://localhost/api/projects/architecto/forecast"
+);
+
+const headers = {
+ "Content-Type": "application/json",
+ "Accept": "application/json",
+};
+
+let body = {
+ "forecasted_effort": {
+ "2024-02": 40,
+ "2024-03": 60
+ }
+};
+
+fetch(url, {
+ method: "PUT",
+ headers,
+ body: JSON.stringify(body),
+}).then(response => response.json());++Example response (200):
+
+
+{
+ "id": "550e8400-e29b-41d4-a716-446655440000",
+ "forecasted_effort": {
+ "2024-02": 40,
+ "2024-03": 60
+ }
+}
+
+ ++Example response (404):
+
+
+{
+ "message": "Project not found"
+}
+
+ ++Example response (422):
+
+
+{
+ "message": "Forecasted effort exceeds approved estimate by more than 5%"
+}
+
+
+
+ Received response: ++
Request failed with error:+
+
+Tip: Check that you're properly connected to the network.
+If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
+You can check the Dev Tools console for debugging information.