> ## Documentation Index > Fetch the complete documentation index at: https://woku.app/docs/llms.txt > Use this file to discover all available pages before exploring further. # List the action plan groups of the caller company ## OpenAPI ````yaml /openapi-v1.json get /v1/action-plan-groups openapi: 3.0.3 info: title: Woku Client API v1 description: >- Public Woku Client API. Switch the version selector at the top to view the v0 reference. This spec covers: - **Wokus** — create wokus, fetch review data, submit text/voice reviews, share by email. - **Companies** — `GET /companies/me` returns the caller company. - **Reports** — company-wide and per-tool NPS reports. - **External Trackers** — tag your Wokus with identifiers from third-party systems (CRM transaction id, ERP order id, etc.) and look them up later. - **Ticket Destinations** — configure the SAC platforms (Zendesk, Salesforce, Slack), custom HTTP service or email addresses that receive AI-triaged support tickets, and the tracker conditions that route a ticket to one. - **Action Plan Groups** — define which VoC feedback (tracker conditions) drafts an improvement plan and who is responsible. - **Action Plans** — read AI-drafted plans and drive their lifecycle (approve, send to an external tool or work them in woku's managed kanban). ## Authentication All endpoints require a Bearer token in the `Authorization` header. Obtain your company API key from the Woku dashboard. ``` Authorization: Bearer your_api_key_here ``` ## Base URL Production: `https://clientapi.woku.app` ## Model (External Trackers) - **Tracker definition** (`ExternalTracker`): a per-company catalog entry like `{ name: 'trr', system: 'crm interno', description: '...' }`. Defined by an admin in the Woku dashboard. - **Tracker value** (`WokuExternalTrackerValue`): a string value bound to a (Woku, Tracker) pair. Multiple Wokus may share the same value. ## Model (routing / group conditions) `TicketRoutingCondition` (Ticket Destinations) and `ActionPlanGroupCondition` (Action Plan Groups) share the same shape: a boolean expression of rows over `ExternalTracker` values, AND binding tighter than OR. Each row matches when the feedback carries `trackerId` with a value that, for operator `equals`, equals `value`, or, for operator `any`, is any value at all (the whole tracker; `value` is then omitted). `relationToPrevious` joins a row to the previous one (`AND` same group, `OR` starts a new group); the first row omits it. version: 1.0.0 contact: name: Woku Support url: https://woku.app email: team@woku.app servers: - url: https://clientapi.woku.app description: Production server security: [] tags: - name: Wokus description: >- Create wokus, fetch review data, submit text and voice reviews, share review links by email. - name: Companies description: Caller-company endpoint. - name: Reports description: NPS reports for the caller company and individual NPS tools. - name: NPS description: >- Capture NPS scores (company-level or per NPS tool) and fetch NPS tool definitions. - name: CSAT description: >- Capture CSAT (1-5 satisfaction) scores company-level or per CSAT tool, fetch tool definitions and responses, and submit text and voice feedback. - name: CES description: >- Capture CES (effort) scores company-level or per CES tool, fetch tool definitions and responses, and submit text and voice feedback. - name: External Trackers description: >- Tag Wokus with identifiers from external systems and look them up by name + value. - name: Quarantines description: >- Check whether a respondent is currently quarantined before prompting for feedback. - name: Invitations description: >- Survey distribution: send NPS surveys, forms and woku review invitations by email or WhatsApp. - name: Forms description: Fetch form definitions and submit responses from your own UI. - name: Flows description: Render flow journeys (ordered wokus with an optional NPS) in your own app. - name: Captures description: Mobile SDK capture ingestion - name: Ticket Destinations description: >- Configure where AI-triaged support tickets are delivered (Zendesk, Salesforce, Slack, a custom HTTP service, or plain email) and the tracker-based routing that picks a destination. - name: Action Plan Groups description: >- Define which VoC feedback (tracker conditions) drafts an action plan and who the responsibles are. - name: Action Plans description: >- Read AI-drafted improvement plans and drive their lifecycle: approve, send to Jira/monday.com/ClickUp/Notion or work them inside woku's managed kanban. paths: /v1/action-plan-groups: get: tags: - Action Plan Groups summary: List the action plan groups of the caller company operationId: listActionPlanGroups parameters: - name: search in: query required: false description: Free-text search over name, description and condition values. schema: type: string maxLength: 200 responses: '200': description: Action plan groups content: application/json: schema: type: array items: $ref: '#/components/schemas/ActionPlanGroup' '403': description: Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' security: - BearerAuth: [] components: schemas: ActionPlanGroup: type: object properties: _id: type: string example: 507f1f77bcf86cd799439031 companyId: type: string name: type: string description: type: string conditions: type: array items: $ref: '#/components/schemas/ActionPlanGroupCondition' members: type: array items: $ref: '#/components/schemas/ActionPlanGroupMember' threshold: type: integer example: 300 enabled: type: boolean description: >- A disabled group stops counting feedback and generating drafts, but keeps its history and stats visible. default: true counterSince: type: string format: date-time description: >- Base date of the negatives counter: only feedback created after it counts toward `threshold`. createdAt: type: string format: date-time updatedAt: type: string format: date-time ForbiddenError: type: object properties: statusCode: type: integer example: 403 message: type: string example: Authentication required error: type: string example: Forbidden ActionPlanGroupCondition: type: object description: >- One condition row: feedback must carry `trackerId` with a value that matches per `operator`. Rows form a boolean expression (AND binds tighter than OR) via `relationToPrevious`; the group counts a feedback item when ANY OR-group of its rows fully matches. required: - trackerId properties: relationToPrevious: type: string enum: - AND - OR description: Joins this row to the previous one. Omitted on the first row. trackerId: type: string description: ExternalTracker id (the company's tracker catalog). example: 507f1f77bcf86cd799439011 operator: type: string enum: - equals - any default: equals description: >- `equals` matches the tracker value against `value`. `any` matches any value of the tracker (the whole tracker; `value` is omitted). value: type: string maxLength: 200 description: The value the tracker must equal. Required unless operator is "any". ActionPlanGroupMember: type: object required: - userId - role properties: userId: type: string description: Company member user id. example: 507f1f77bcf86cd799439013 role: type: string enum: - admin - assignee description: >- `admin` approves/sends plans; `assignee` works on tasks. A group needs at least one of each. securitySchemes: BearerAuth: type: http scheme: bearer description: >- Company API key. Obtain this from your Woku dashboard under Settings > API Keys. The same key used for the v0 endpoints. ````