> ## Documentation Index
> Fetch the complete documentation index at: https://docs.beyondwords.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List project voices

> Lists project voices within a project



## OpenAPI

````yaml get /organization/voices/permissions
openapi: 3.0.1
info:
  title: BeyondWords REST API
  description: |-
    This is the documentation for the BeyondWords REST API.
              You can use this API to use BeyondWords programmatically.
              You can get your API Key and Project ID for each project in the Project settings tab in the BeyondWords
              <a href="https://dash.beyondwords.io/dashboard">dashboard</a>.
  version: 1.0.0
servers:
  - url: https://api.beyondwords.io/v1
security: []
paths:
  /organization/voices/permissions:
    get:
      tags:
        - Project voices
      summary: List
      description: Lists project voices within a project
      operationId: organization/voices/permissions#index
      parameters:
        - name: pagination[limit]
          in: query
          required: false
          description: '''limit'' sets the number of results to return in each page.'
          schema:
            type: integer
        - name: pagination[offset]
          in: query
          required: false
          description: >-
            'offset' sets the first position to return from the results of the
            query. The default is 0, which starts the page at the first result.
          schema:
            type: integer
        - name: filter[project.id]
          in: query
          required: false
          description: filter by project id
          schema:
            type: string
        - name: filter[voice.id]
          in: query
          required: false
          description: filter by voice id
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            X-Pagination-Limit:
              description: |-
                The requested number of results to be returned for this request.
                          The actual number of results returned may be lower.
              schema:
                type: integer
              required: false
            X-Pagination-OffSet:
              description: >-
                The position of the first result in the response (before
                pagination was applied).
              schema:
                type: integer
              required: false
            X-Pagination-Total-Count:
              description: >-
                The total number of results returned for this query (before
                pagination was applied).
              schema:
                type: integer
              required: false
          content:
            application/json:
              examples:
                example:
                  $ref: '#/components/examples/projectVoicesExample'
              schema:
                $ref: '#/components/schemas/projectVoicesModel'
        '401':
          description: Invalid authentication token
          content:
            application/json:
              examples:
                example:
                  $ref: '#/components/examples/unauthorizedErrorExample'
              schema:
                $ref: '#/components/schemas/errorModel'
      security:
        - apiKey: []
components:
  examples:
    projectVoicesExample:
      summary: Sample list of project voices response
      value:
        - id: 1
          project:
            id: 1
            name: Test project
          voice:
            id: 1
            name: Test voice
          included: true
          created: 2023-01-01 00:00:00 UTC
          updated: 2023-01-01 00:00:05 UTC
        - id: 2
          project:
            id: 1
            name: Test project
          voice:
            id: 1
            name: Test voice
          included: true
          created: 2023-01-01 00:00:00 UTC
          updated: 2023-01-01 00:00:05 UTC
    unauthorizedErrorExample:
      summary: Unauthorized error
      value:
        code: 401
        message: Unauthorized
  schemas:
    projectVoicesModel:
      type: array
      items:
        $ref: '#/components/schemas/projectVoiceModel'
    errorModel:
      type: object
      properties:
        code:
          type: integer
          description: Error code
        message:
          type: string
          description: Error message
        errors:
          type: array
          nullable: true
          items:
            type: object
            properties:
              location:
                type: string
              message:
                type: string
    projectVoiceModel:
      type: object
      properties:
        id:
          type: integer
        project:
          type: object
          nullable: false
          properties:
            id:
              type: integer
            name:
              type: string
              nullable: true
            title:
              type: object
              properties:
                enabled:
                  type: boolean
                  nullable: false
                  description: >-
                    Whether or not content titles should be included in the
                    audio. The default is `true`
                voice:
                  type: object
                  nullable: true
                  properties:
                    id:
                      type: integer
                      description: The title voice id
                    name:
                      type: string
                      description: The title voice name
            summary:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
                  nullable: false
                  description: >-
                    Whether or not content summaries should be included in the
                    audio. The default is `false`
                voice:
                  type: object
                  nullable: true
                  properties:
                    id:
                      type: integer
                      description: The summary voice id
                    name:
                      type: string
                      description: The summary voice name
            body:
              type: object
              properties:
                enabled:
                  type: boolean
                  nullable: false
                  description: >-
                    Whether or not content bodies should be included in the
                    audio. The default is `true`
                voice:
                  type: object
                  nullable: true
                  properties:
                    id:
                      type: integer
                      description: The body voice id
                    name:
                      type: string
                      description: The body voice name
        voice:
          type: object
          nullable: false
          properties:
            id:
              type: integer
            name:
              type: string
              nullable: true
        included:
          type: boolean
          nullable: false
        created:
          type: string
          format: date-time
          description: Time at which the object was created (ISO 8601)
        updated:
          type: string
          format: date-time
          description: Time at which the object was updated (ISO 8601)
  securitySchemes:
    apiKey:
      type: apiKey
      name: X-Api-Key
      in: header

````