Skip to content

List engagements

Request

Project engagement tracking with comprehensive workflow management

This endpoint delivers complete project engagement management including:

  • Client engagement tracking with date-based filtering
  • Multi-level staff assignment management (partner and manager roles)
  • Project status workflow tracking and reporting
  • Template-driven engagement naming and standardization
  • Date range analysis for project timeline management

Project Management Capabilities:

  • Start and end date tracking for project lifecycles
  • Status-based workflow management (ACTIVE, COMPLETED, ON_HOLD, EXECUTED, etc.)
  • Staff assignment tracking at partner and manager levels
  • Client relationship management for engagement context

Workflow Features:

  • Template-based engagement creation for consistency
  • Status progression tracking for project milestones
  • Staff allocation and responsibility assignment
  • Client-specific engagement history and analysis

Business Intelligence:

  • Engagement duration analysis and reporting
  • Staff utilization and assignment tracking
  • Client engagement patterns and history
  • Project status distribution and workflow analysis

Filtering and Analysis:

  • Client-specific engagement retrieval
  • Status-based workflow filtering
  • Date range queries for period analysis
  • Staff assignment reporting and allocation

Real Example:

curl --location 'https://{{host}}/v1/engagements' \
--header 'Authorization: bearer {{token}} \
--header 'Content-Type: application/json' \
--data '{
  "pageSize": 25,
  "page": 0
}'
Security
BearerAuth
Bodyapplication/json
pageSizeinteger, [ 1 .. 1000 ]

Maximum number of engagement records to return

Default:25
Example:25
pageinteger, >= 0

Page number for pagination (0-based)

Default:0
Example:0
clientIdinteger

Filter engagements by specific client ID

Example:420
statusstring

Filter by engagement status

Enum:"ACTIVE""COMPLETED""ON_HOLD""EXECUTED""CANCELLED""PLANNED"
Example:"EXECUTED"
startDatestring, (date)

Start date for engagement date range filter

Example:"2023-06-29"
endDatestring, (date)

End date for engagement date range filter

Example:"2023-06-29"
sortOrderstring

Sort order for engagement dates

Default:"desc"
Enum:"asc""desc"
Example:"desc"
curl -i -X POST \
  https://api.doc.aiwyn.ai/_mock/bundle/gql/v1/engagements \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pageSize": 25,
    "page": 0
  }'

Responses

Successfully retrieved engagement records

Bodyapplication/json
deid_engagementArray of objects
deid_engagement_aggregateobject
Response
{
  "deid_engagement": [
    { … },
    { … }
  ],
  "deid_engagement_aggregate": {
    "aggregate": { … }
  }
}