# Get Preferences

> GET /api/v1/organizations/preferences — request parameters and responses from the Menace Voice API schema.

`GET /api/v1/organizations/preferences`

{/* Generated by scripts/sync_docs_api.mjs. Edit the API schema source to change the contract. */}

See [authentication](/api-reference/authentication) for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

## API contract for documentation tools

Generated from the OpenAPI schema. Do not infer a different parameter type from an example. Authentication headers are alternatives as explained in the authentication guide.

### Parameters

| Name | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| authorization | header | string or null | no |  |
| X-API-Key | header | string or null | no |  |

### Response 200

Successful Response

application/json: OrganizationPreferences (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| test_phone_number | string or null | no |  |
| timezone | string or null | no |  |
| external_pbx_integrations_enabled | boolean | no | default: false |
| disposition_mapping_enabled | boolean | no | default: false |
| disposition_mapping | object | no | Menace Voice disposition -> the code this organization uses for it. Applied when writing `gathered_context.mapped_call_disposition`, so webhooks, run filters, reports and external-PBX write-backs all read the organization's own vocabulary. Dispositions absent from the mapping pass through unchanged. |

### Response 404

Not found

### Response 422

Validation Error

application/json: HTTPValidationError (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| detail | array of ValidationError (object) | no |  |

## OpenAPI

````yaml api-reference/openapi.json get /api/v1/organizations/preferences
openapi: 3.1.0
info:
  title: Menace Voice API
  description: API for Menace Voice agents
  version: 1.0.0
servers:
  - url: https://voice.menaceui.com
    description: Production
  - url: http://localhost:8000
    description: Local development
paths:
  /api/v1/organizations/preferences:
    get:
      tags:
        - main
        - organizations
      summary: Get Preferences
      operationId: get_preferences_api_v1_organizations_preferences_get
      parameters:
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: Authorization
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: X-Api-Key
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OrganizationPreferences"
        "404":
          description: Not found
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OrganizationPreferences:
      properties:
        test_phone_number:
          anyOf:
            - type: string
            - type: "null"
          title: Test Phone Number
        timezone:
          anyOf:
            - type: string
            - type: "null"
          title: Timezone
        external_pbx_integrations_enabled:
          type: boolean
          title: External Pbx Integrations Enabled
          default: false
        disposition_mapping_enabled:
          type: boolean
          title: Disposition Mapping Enabled
          default: false
        disposition_mapping:
          additionalProperties:
            type: string
          type: object
          title: Disposition Mapping
          description: Menace Voice disposition -> the code this organization uses for it.
            Applied when writing `gathered_context.mapped_call_disposition`, so
            webhooks, run filters, reports and external-PBX write-backs all read
            the organization's own vocabulary. Dispositions absent from the
            mapping pass through unchanged.
      type: object
      title: OrganizationPreferences
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
````