Skip to content
/
Get project by ID

Get project by ID

Request

Retrieve a specific project by its unique identifier

This endpoint provides detailed project information including:

  • Complete project details and specifications
  • Project status and lifecycle information
  • Client and engagement relationships
  • Team assignments and resource allocation
  • Budget and financial tracking data
  • Timeline and milestone information

Project Management Features:

  • Project lifecycle tracking
  • Resource allocation and team management
  • Budget and financial oversight
  • Timeline and milestone management
  • Client relationship integration

Project Details Include:

  • Project name and description
  • Project status and phase
  • Client and engagement references
  • Team member assignments
  • Budget and financial data
  • Timeline and milestone tracking

Business Applications:

  • Project status monitoring
  • Resource allocation analysis
  • Budget tracking and reporting
  • Client project portfolio management
  • Team performance analysis

Real Example:

curl --location 'https://{{host}}/v1/project/67890' \
--header 'Authorization: bearer {{token}}' \
--header 'Content-Type: application/json'

Response Example:

{
  "id": 67890,
  "name": "Q4 Financial Audit",
  "description": "Comprehensive financial audit for Q4 2024 including tax preparation and compliance review",
  "status": "IN_PROGRESS",
  "phase": "EXECUTION",
  "clientId": 789,
  "clientName": "Acme Corporation",
  "engagementId": 456,
  "engagementName": "Annual Audit Engagement",
  "startDate": "2024-10-01T00:00:00Z",
  "endDate": "2024-12-31T23:59:59Z",
  "budget": 25000.00,
  "currency": "USD",
  "actualCost": 18500.00,
  "teamMembers": [
    {
      "staffId": 123,
      "name": "John Smith",
      "role": "SENIOR_AUDITOR",
      "allocation": 0.8
    },
    {
      "staffId": 124,
      "name": "Jane Doe",
      "role": "AUDITOR",
      "allocation": 0.6
    }
  ],
  "milestones": [
    {
      "id": 1,
      "name": "Planning Phase Complete",
      "dueDate": "2024-10-15T00:00:00Z",
      "status": "COMPLETED"
    },
    {
      "id": 2,
      "name": "Fieldwork Complete",
      "dueDate": "2024-12-15T00:00:00Z",
      "status": "IN_PROGRESS"
    }
  ],
  "createdAt": "2024-09-15T10:00:00Z",
  "updatedAt": "2024-11-20T14:30:00Z"
}
Security
BearerAuth
Path
idinteger, >= 1required

Unique identifier of the project

Example:67890
curl -i -X GET \
  https://api.doc.aiwyn.ai/_mock/bundle/gql/v1/project/67890 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Project details retrieved successfully

Bodyapplication/json
idinteger

Unique project identifier

Example:67890
namestring

Project name

Example:"Q4 Financial Audit"
descriptionstring

Detailed project description

Example:"Comprehensive financial audit for Q4 2024 including tax preparation and compliance review"
statusstring

Current project status

Enum:"PLANNING""IN_PROGRESS""ON_HOLD""COMPLETED""CANCELLED"
Example:"IN_PROGRESS"
phasestring

Current project phase

Enum:"PLANNING""EXECUTION""REVIEW""DELIVERY""CLOSED"
Example:"EXECUTION"
clientIdinteger

Associated client identifier

Example:789
clientNamestring

Name of the client

Example:"Acme Corporation"
engagementIdinteger

Associated engagement identifier

Example:456
engagementNamestring

Name of the engagement

Example:"Annual Audit Engagement"
startDatestring, (date-time)

Project start date

Example:"2024-10-01T00:00:00Z"
endDatestring, (date-time)

Project end date

Example:"2024-12-31T23:59:59Z"
budgetnumber, (decimal)

Project budget amount

Example:25000
currencystring

Budget currency code

Example:"USD"
actualCostnumber, (decimal)

Actual cost incurred to date

Example:18500
teamMembersArray of objects

Team members assigned to the project

milestonesArray of objects

Project milestones

createdAtstring, (date-time)

Project creation timestamp

Example:"2024-09-15T10:00:00Z"
updatedAtstring, (date-time)

Last update timestamp

Example:"2024-11-20T14:30:00Z"
Response
{
  "id": 67890,
  "name": "Q4 Financial Audit",
  "description": "Comprehensive financial audit for Q4 2024 including tax preparation and compliance review",
  "status": "IN_PROGRESS",
  "phase": "EXECUTION",
  "clientId": 789,
  "clientName": "Acme Corporation",
  "engagementId": 456,
  "engagementName": "Annual Audit Engagement",
  "startDate": "2024-10-01T00:00:00Z",
  "endDate": "2024-12-31T23:59:59Z",
  "budget": 25000,
  "currency": "USD",
  "actualCost": 18500,
  "teamMembers": [
    { … }
  ],
  "milestones": [
    { … }
  ],
  "createdAt": "2024-09-15T10:00:00Z",
  "updatedAt": "2024-11-20T14:30:00Z"
}