Get engagement by ID

Request

Retrieve a specific engagement by its unique identifier

This endpoint provides detailed engagement information including:

Complete engagement details and scope
Engagement status and lifecycle information
Client relationship and contact details
Project portfolio and deliverables
Team assignments and resource allocation
Financial terms and billing arrangements

Engagement Management Features:

Engagement lifecycle tracking
Client relationship management
Project portfolio oversight
Team resource allocation
Financial terms and billing setup

Engagement Details Include:

Engagement name and description
Engagement status and type
Client and contact information
Project portfolio details
Team assignments
Financial terms and billing

Business Applications:

Engagement status monitoring
Client relationship management
Project portfolio analysis
Resource allocation planning
Financial performance tracking

Real Example:

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

Response Example:

{
  "id": 34567,
  "name": "Annual Audit Engagement 2024",
  "description": "Comprehensive annual audit engagement including financial statements, tax preparation, and compliance review",
  "status": "ACTIVE",
  "type": "AUDIT",
  "clientId": 789,
  "clientName": "Acme Corporation",
  "clientEmail": "finance@acme.com",
  "clientPhone": "+1-555-0123",
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-12-31T23:59:59Z",
  "estimatedValue": 50000.00,
  "currency": "USD",
  "projects": [
    {
      "id": 67890,
      "name": "Q4 Financial Audit",
      "status": "IN_PROGRESS",
      "budget": 25000.00
    },
    {
      "id": 67891,
      "name": "Tax Preparation",
      "status": "PLANNING",
      "budget": 15000.00
    }
  ],
  "teamMembers": [
    {
      "staffId": 123,
      "name": "John Smith",
      "role": "ENGAGEMENT_PARTNER",
      "allocation": 0.3
    },
    {
      "staffId": 124,
      "name": "Jane Doe",
      "role": "SENIOR_MANAGER",
      "allocation": 0.8
    }
  ],
  "billingTerms": {
    "billingFrequency": "MONTHLY",
    "paymentTerms": "NET_30",
    "rateType": "HOURLY",
    "defaultRate": 250.00
  },
  "notes": "Annual engagement with quarterly reviews and monthly billing",
  "createdAt": "2023-12-15T10:00:00Z",
  "updatedAt": "2024-11-20T14:30:00Z"
}

Security

BearerAuth

Path

idinteger, >= 1required

Unique identifier of the engagement

Example:34567

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

Responses

Engagement details retrieved successfully

Bodyapplication/json

idinteger

Unique engagement identifier

Example:34567

namestring

Engagement name

Example:"Annual Audit Engagement 2024"

descriptionstring

Detailed engagement description

Example:"Comprehensive annual audit engagement including financial statements, tax preparation, and compliance review"

statusstring

Engagement status

Enum:"PLANNING""ACTIVE""ON_HOLD""COMPLETED""CANCELLED"

Example:"ACTIVE"

typestring

Engagement type

Enum:"AUDIT""REVIEW""COMPILATION""TAX""CONSULTING""ADVISORY"

Example:"AUDIT"

clientIdinteger

Associated client identifier

Example:789

clientNamestring

Client name

Example:"Acme Corporation"

clientEmailstring

Primary client contact email

Example:"finance@acme.com"

clientPhonestring

Primary client contact phone

Example:"+1-555-0123"

startDatestring, (date-time)

Engagement start date

Example:"2024-01-01T00:00:00Z"

endDatestring, (date-time)

Engagement end date

Example:"2024-12-31T23:59:59Z"

estimatedValuenumber, (decimal)

Estimated engagement value

Example:50000

currencystring

Engagement currency code

Example:"USD"

projectsArray of objects

Projects within this engagement

teamMembersArray of objects

Team members assigned to the engagement

billingTermsobject

Billing terms and arrangements

notesstring

Additional notes or terms

Example:"Annual engagement with quarterly reviews and monthly billing"

createdAtstring, (date-time)

Engagement creation timestamp

Example:"2023-12-15T10:00:00Z"

updatedAtstring, (date-time)

Last update timestamp

Example:"2024-11-20T14:30:00Z"

Response

{
  "id": 34567,
  "name": "Annual Audit Engagement 2024",
  "description": "Comprehensive annual audit engagement including financial statements, tax preparation, and compliance review",
  "status": "ACTIVE",
  "type": "AUDIT",
  "clientId": 789,
  "clientName": "Acme Corporation",
  "clientEmail": "finance@acme.com",
  "clientPhone": "+1-555-0123",
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-12-31T23:59:59Z",
  "estimatedValue": 50000,
  "currency": "USD",
  "projects": [
    { … }
  ],
  "teamMembers": [
    { … }
  ],
  "billingTerms": {
    "billingFrequency": "MONTHLY",
    "paymentTerms": "NET_30",
    "rateType": "HOURLY",
    "defaultRate": 250
  },
  "notes": "Annual engagement with quarterly reviews and monthly billing",
  "createdAt": "2023-12-15T10:00:00Z",
  "updatedAt": "2024-11-20T14:30:00Z"
}