> ## 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 company data

> Retrieves comprehensive company information including folders, wokus, and NPS data using the company API key provided in the Authorization header.



## OpenAPI

````yaml /openapi.json get /companies
openapi: 3.0.3
info:
  title: Woku Client API
  description: >-
    API for integrating with Woku's feedback collection platform. This API
    allows you to create wokus (feedback collection tools), submit reviews, and
    retrieve reports.


    ## Authentication


    All endpoints require authentication using a Bearer token in the
    Authorization header. You can obtain your API key from the Woku dashboard.


    ```

    Authorization: Bearer your_api_key_here

    ```


    ## Base URL


    Production: `https://api.woku.app`
  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: Endpoints for creating and managing wokus (feedback collection tools)
  - name: Reviews
    description: Endpoints for submitting and retrieving reviews
  - name: Companies
    description: Endpoints for retrieving company data
  - name: Reports
    description: Endpoints for retrieving NPS and analytics reports
paths:
  /companies:
    get:
      tags:
        - Companies
      summary: Get company data
      description: >-
        Retrieves comprehensive company information including folders, wokus,
        and NPS data using the company API key provided in the Authorization
        header.
      operationId: getCompanyData
      responses:
        '200':
          description: Company data retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyDataResponse'
        '401':
          description: Invalid or missing authorization key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
      security:
        - BearerAuth: []
components:
  schemas:
    CompanyDataResponse:
      type: object
      properties:
        company:
          type: object
          properties:
            _id:
              type: string
              format: objectid
              example: 507f1f77bcf86cd799439020
            name:
              type: string
              description: Company name
              example: Acme Corporation
            email:
              type: string
              format: email
              example: contact@acme.com
        folders:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
                format: objectid
              name:
                type: string
                example: 'Store #123'
              secondaryKey:
                type: string
                example: store-123
              wokusCount:
                type: integer
                example: 15
          description: Array of folders belonging to the company
        wokus:
          type: array
          items:
            $ref: '#/components/schemas/WokuResponse'
          description: Array of wokus belonging to the company
        nps:
          type: object
          properties:
            score:
              type: number
              description: Overall NPS score (-100 to 100)
              example: 45
            totalResponses:
              type: integer
              description: Total number of NPS responses
              example: 250
    UnauthorizedError:
      type: object
      properties:
        statusCode:
          type: integer
          example: 401
        message:
          type: string
          example: Invalid or missing API key
    WokuResponse:
      type: object
      properties:
        _id:
          type: string
          format: objectid
          description: Unique identifier of the woku
          example: 507f1f77bcf86cd799439011
        description:
          type: string
          description: Description of the woku
          example: 'Customer Service Experience - Store #123'
        createdBy:
          type: string
          format: objectid
          description: User ID who created the woku
          example: 507f1f77bcf86cd799439012
        companyId:
          type: string
          format: objectid
          description: Company ID the woku belongs to
          example: 507f1f77bcf86cd799439013
        folderId:
          type: string
          format: objectid
          description: Folder ID the woku is organized in
          example: 507f1f77bcf86cd799439014
        file:
          $ref: '#/components/schemas/WokuFile'
        qualifications:
          type: array
          items:
            $ref: '#/components/schemas/WokuQualification'
          description: Array of star ratings
        textnotes:
          type: array
          items:
            $ref: '#/components/schemas/WokuTextnote'
          description: Array of text reviews
        voicemails:
          type: array
          items:
            $ref: '#/components/schemas/WokuVoicemail'
          description: Array of voice reviews
        feedbacksSummary:
          type: string
          description: AI-generated summary of all feedback
          example: Customers generally praise the helpful staff and quick service...
        closed:
          type: boolean
          description: Whether the woku is closed for new reviews
          default: false
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp
          example: '2026-01-20T10:30:00.000Z'
        updatedAt:
          type: string
          format: date-time
          description: Last update timestamp
          example: '2026-01-20T15:45:00.000Z'
    WokuFile:
      type: object
      properties:
        filename:
          type: string
          description: Name of the file
          example: product-image.webp
        type:
          type: string
          enum:
            - image
            - video
          description: Type of the file
          example: image
        url:
          type: string
          format: uri
          description: Public URL of the file
          example: https://cdn.woku.app/files/product-image.webp
    WokuQualification:
      type: object
      properties:
        _id:
          type: string
          format: objectid
          description: Unique identifier
          example: 507f1f77bcf86cd799439015
        qualification:
          type: integer
          minimum: 1
          maximum: 5
          description: Star rating
          example: 5
        createdBy:
          type: string
          description: User or client who created the rating
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp
    WokuTextnote:
      type: object
      properties:
        _id:
          type: string
          format: objectid
          description: Unique identifier
          example: 507f1f77bcf86cd799439016
        qualification:
          type: object
          properties:
            qualification:
              type: integer
              minimum: 1
              maximum: 5
              description: Star rating
              example: 5
        description:
          type: string
          description: Text content of the review
          example: Excellent service!
        anonymous:
          type: boolean
          description: Whether the review is anonymous
          example: false
        feedbackType:
          type: string
          description: AI-classified feedback type
          example: positive
        clientId:
          type: string
          format: objectid
          description: Client who submitted the review
        validated:
          type: boolean
          description: Whether the review has been validated
          example: true
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp
    WokuVoicemail:
      type: object
      properties:
        _id:
          type: string
          format: objectid
          description: Unique identifier
          example: 507f1f77bcf86cd799439017
        qualification:
          type: object
          properties:
            qualification:
              type: integer
              minimum: 1
              maximum: 5
              description: Star rating
              example: 4
        file:
          type: object
          properties:
            filename:
              type: string
              description: Audio file name
              example: voicemail.mp4
            url:
              type: string
              format: uri
              description: Public URL of the audio file
        transcription:
          type: string
          description: AI-generated transcription of the audio
          example: I had a great experience with your service...
        anonymous:
          type: boolean
          description: Whether the review is anonymous
          example: false
        feedbackType:
          type: string
          description: AI-classified feedback type
          example: positive
        clientId:
          type: string
          format: objectid
          description: Client who submitted the review
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Company API key. Obtain this from your Woku dashboard under Settings >
        API Keys.

````