Get Preferences

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

2 min read

get/api/v1/organizations/preferences

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/organizations/preferences \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>'

Response

{
  "test_phone_number": "<string>",
  "timezone": "<string>",
  "external_pbx_integrations_enabled": false,
  "disposition_mapping_enabled": false,
  "disposition_mapping": {}
}

get/api/v1/organizations/preferences

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

test_phone_numberstring · null#

Show child attributes

Any of

timezonestring · null#

Show child attributes

Any of

external_pbx_integrations_enabledboolean#

Default: false

disposition_mapping_enabledboolean#

Default: false

disposition_mappingobject#

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.

Show child attributes

{key}string#

Get Disposition Codes Save Preferences