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

# List projects

> Lists the projects your credential can reach. With an organization API key these are the projects of the key's organization. Use a project's `id` as the `projectId` path parameter of every other endpoint.



## OpenAPI

````yaml api-reference/voice-openapi.json GET /v1/projects
openapi: 3.0.3
info:
  title: Clarity Voice API
  version: '1.0'
  description: >-
    Voice agents and their tools, outbound calls, conversations, campaigns,
    telephony, and evals.
servers:
  - url: https://voice-api.onclarity.com
security:
  - organizationApiKey: []
tags:
  - name: Projects
    description: >-
      The projects your organization owns. Every other resource lives in a
      project.
  - name: Agents
    description: Create, configure, version and publish voice agents.
  - name: Outbound calls
    description: Have a published agent phone a number now.
  - name: Conversations
    description: >-
      One record per call session, with its calls, recordings, transcripts and
      artifacts.
  - name: Calls
    description: The calls of a project, with their status, direction, timing and outcome.
  - name: Campaigns
    description: Outbound calling campaigns that phone a list of numbers on a schedule.
  - name: Eval suites
    description: >-
      Reusable sets of eval scenarios and test cases to measure an agent
      against.
  - name: Eval judges
    description: The LLM judges that score eval calls against your test cases.
  - name: Eval scenarios
    description: The simulated-caller scenarios of your eval suites.
  - name: Eval test cases
    description: The checks a judge applies to each eval call.
  - name: Eval submissions
    description: Run an eval suite against an agent and read the verdicts.
  - name: Phone numbers
    description: >-
      The phone numbers of a project, where their calls come from, and how
      agents call out from them.
  - name: Inbound SIP trunks
    description: Bring calls from your own SIP infrastructure to Clarity agents.
  - name: Outbound SIP trunks
    description: >-
      The SIP endpoints Clarity dials through for outbound calls from your
      numbers.
  - name: Tools
    description: The tools agents call during a conversation, and which agents use them.
paths:
  /v1/projects:
    get:
      tags:
        - Projects
      summary: List projects
      description: >-
        Lists the projects your credential can reach. With an organization API
        key these are the projects of the key's organization. Use a project's
        `id` as the `projectId` path parameter of every other endpoint.
      operationId: listProjects
      responses:
        '200':
          description: The projects you can reach.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectsListResponse'
              example:
                projects:
                  - id: 3f6c1a52-8d0e-4b8f-9a51-2c7d4e0b9f13
                    name: Customer support
                    organization_id: 42
                    livekit_mode: cloud
                    livekit_self_hosted_available: false
                    region_profile: null
                    region_profile_display_name: null
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ProjectsListResponse:
      type: object
      required:
        - projects
      properties:
        projects:
          type: array
          items:
            $ref: '#/components/schemas/Project'
    Project:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: string
        name:
          type: string
        voc_project_id:
          type: string
        voc_api_token_configured:
          type: boolean
        activated_inbound_phone_numbers:
          type: array
          items:
            type: string
        activated_outbound_phone_numbers:
          type: array
          items:
            type: string
        organization_id:
          type: integer
          description: The organization that owns the project.
        livekit_mode:
          type: string
          enum:
            - cloud
            - self-hosted
          description: >-
            Which media server this project's calls run on (defaults to
            `cloud`).
        livekit_self_hosted_available:
          type: boolean
          description: >-
            Read-only. Whether a self-hosted media server is available on this
            deployment.
        region_profile:
          type: string
          nullable: true
          description: >-
            Read-only. The organization's region profile id, or null for the
            deployment default. While set, `livekit_mode` is decided by the
            profile and a manual change answers 409 `REGION_PROFILE_PINNED`.
          example: ksa-selfhosted
        region_profile_display_name:
          type: string
          nullable: true
          description: Read-only. Display name of `region_profile`.
          example: Saudi Arabia (in-Kingdom, self-hosted)
        region_conflict:
          type: string
          enum:
            - telephony_on_other_media_server
            - invalid_profile
            - media_server_not_configured
          description: >-
            Read-only. Why the organization's region profile cannot be applied
            to this project; absent when consistent. While present, new calls
            and agent changes on the project answer 503
            `REGION_PROFILE_CONFLICT`; reads work.
        telephony:
          type: object
          description: Read-only, platform administrators only. Explains a region conflict.
          properties:
            phone_numbers:
              type: integer
            sip_trunks:
              type: integer
    Error:
      type: object
      required:
        - error
      additionalProperties: true
      properties:
        error:
          type: string
          description: Error message
        code:
          type: string
          description: >-
            A stable machine-readable reason, present on the refusals a client
            may branch on. Among them: `PUBLISH_CAPABILITY_REQUIRED` (403, the
            credential may not change what is live), `AGENT_NOT_PUBLISHED` (409,
            the agent has no published version yet),
            `AGENT_TYPE_NOT_DISPATCHABLE` (422, a Voice Assist agent named where
            an agent must place a call or answer one itself — a campaign, an
            outbound caller ID, a dispatched call, an eval; a number's inbound
            dispatch rule accepts one; the body carries `agent_type` and
            `agent_id`), `ASSIST_FLEET_NOT_CONFIGURED` (422 on a dispatch rule
            naming a Voice Assist agent in a project whose LiveKit has no Voice
            Assist listener), `NOT_APPLICABLE_TO_AGENT_TYPE` (422, a voice-only
            setting written on a Voice Assist agent), `AGENT_TYPE_BOUNDARY`
            (409), `AGENT_TYPE_NOT_SUPPORTED` (400), `INVALID_CUSTOMER_TIMEZONE`
            (400, `customer_timezone` is not a time zone name; the body carries
            the value), `VOICE_ASSISTANT_REQUIRED` (403, the organization is not
            licensed for Voice Assist), `ORGANIZATION_UNAVAILABLE` (503),
            `REGION_PROFILE_CONFLICT` (503), `LLM_SERVICE_TIER_UNAVAILABLE`
            (422, an agent's processing speed is not offered by its model or not
            enabled for the organization; `reason` says which) and
            `AUTH_UPSTREAM_UNAVAILABLE` (503 on any endpoint, with
            `Retry-After`: the credential could not be checked right now; it was
            not rejected and the request was not carried out).
  responses:
    Unauthorized:
      description: >-
        No credential was sent, or the API key is invalid or revoked. A key that
        could not be checked at all answers 503 `AUTH_UPSTREAM_UNAVAILABLE`
        instead (see Errors).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid or revoked token
  securitySchemes:
    organizationApiKey:
      type: http
      scheme: bearer
      description: >-
        Your organization API key (it starts with `anek_org_`). The same key
        works on the Voice API and the Support API. See
        [Authentication](/authentication).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.