> ## 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.

# Get a CES tool definition

> Returns the definition of a CES tool: its internal name, the survey question, an optional follow-up action, and the available and default locales used to render the survey. CES tools are always custom. Fails with 403 if the tool does not belong to the caller company.



## OpenAPI

````yaml /openapi-v1.json get /v1/ces-tool/{id}
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.


    ## 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.
  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
paths:
  /v1/ces-tool/{id}:
    get:
      tags:
        - CES
      summary: Get a CES tool definition
      description: >-
        Returns the definition of a CES tool: its internal name, the survey
        question, an optional follow-up action, and the available and default
        locales used to render the survey. CES tools are always custom. Fails
        with 403 if the tool does not belong to the caller company.
      operationId: v1GetCesTool
      parameters:
        - name: id
          in: path
          required: true
          description: MongoDB ObjectId of the CES tool.
          schema:
            type: string
            pattern: ^[0-9a-fA-F]{24}$
          example: 507f1f77bcf86cd799439011
      responses:
        '200':
          description: CES tool definition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1CesToolResponse'
        '403':
          description: Invalid or missing API key, or tool belongs to another company
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: CES tool not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
        - BearerAuth: []
        - PublishableKey: []
components:
  schemas:
    V1CesToolResponse:
      type: object
      properties:
        _id:
          type: string
          pattern: ^[0-9a-fA-F]{24}$
          example: 507f1f77bcf86cd799439011
        name:
          type: string
          description: Internal name of the CES tool.
          example: Post-support CES
        question:
          type: string
          description: Survey question shown to the respondent.
          example: Resolver tu problema fue facil?
        action:
          type: string
          nullable: true
          description: Optional follow-up action related to the survey.
        availableLocales:
          type: array
          items:
            type: string
        defaultLocale:
          type: string
    ForbiddenError:
      type: object
      properties:
        statusCode:
          type: integer
          example: 403
        message:
          type: string
          example: Authentication required
        error:
          type: string
          example: Forbidden
    NotFoundError:
      type: object
      properties:
        statusCode:
          type: integer
          example: 404
        message:
          type: string
          example: External tracker not found
        error:
          type: string
          example: Not Found
  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.
    PublishableKey:
      type: apiKey
      in: header
      name: x-woku-key
      description: >-
        Publishable capture key (pk_…), safe to embed in the public web widget.
        Accepted only on capture endpoints; scoped to capture (cannot create
        wokus, share, or read reports).

````