Chat icon

Chat

Interact with the Chat API

Actions253

Inbox → Get

AI-generated

Summary

Retrieves the inbox specified by the Inbox parameter for the selected Account.

Inputs

  • accountId (required) — Select the account to use.
  • inboxId (required) — Select the inbox to use

Output shape

An object representing the inbox record as returned by the Approach API getInbox endpoint.

The operation calls the getInbox function in the inbox actions module, which performs a GET request to the Approach platform to fetch the inbox details for the given account and inbox IDs.

Examples

Example 1: Fetch details of an inbox to check its configuration before assigning agents.

Set Account to the desired Approach account (via list or ID) and Inbox to the target inbox (via list or ID).

Links

Discussion