Inboxes

Get an inbox

Get an inbox available in the current account

get/v1/workspaces/{workspace_id}/inboxes/{id}

Request

  • Base URL: https://api.oxvo.com
  • URL: https://api.oxvo.com/v1/workspaces/{workspace_id}/inboxes/{id}
  • Auth: API key in header api_access_token

Path parameters

workspace_idinteger required

The numeric ID of the workspace

idnumber required

ID of the inbox

Response

Success

idnumber

ID of the inbox

namestring

The name of the inbox

website_urlstring

Website URL

channel_typestring

The type of the inbox

avatar_urlstring

The avatar image of the inbox

messenger_colorstring

Widget Color used for customization of the widget

website_tokenstring

Website Token

enable_auto_assignmentboolean

The flag which shows whether Auto Assignment is enabled or not

web_widget_scriptstring

Script used to load the website widget

welcome_titlestring nullable

Welcome title to be displayed on the widget

welcome_taglinestring nullable

Welcome tagline to be displayed on the widget

greeting_enabledboolean

The flag which shows whether greeting is enabled

greeting_messagestring nullable

A greeting message when the user starts the conversation

channel_idnumber

ID of the channel this inbox belongs to

working_hours_enabledboolean

The flag which shows whether working hours feature is enabled

enable_email_collectboolean

The flag to enable collecting email from contacts

csat_survey_enabledboolean

The flag to enable CSAT survey

auto_assignment_configobject

Configuration settings for auto assignment

out_of_office_messagestring nullable

Message to show when agents are out of office

timezonestring

Timezone configuration for the inbox

callback_webhook_urlstring nullable

Webhook URL for callbacks

allow_messages_after_resolvedboolean

Whether to allow messages after a conversation is resolved

lock_to_single_conversationboolean

Whether to lock a contact to a single conversation

sender_name_typestring

Type of sender name to display (e.g., friendly)

business_namestring nullable

Business name associated with the inbox

hmac_mandatoryboolean

Whether HMAC verification is mandatory

selected_feature_flagsstring[] nullable

Selected feature flags for the inbox

reply_timestring

Expected reply time

messaging_service_sidstring nullable

Messaging service SID for SMS providers

phone_numberstring nullable

Phone number associated with the inbox

mediumstring

Medium of communication (e.g., sms, email)

providerstring nullable

Provider of the channel

Changes

No recorded changes to this operation across all 1 revision of this API.