Skip to main content
GET
/
inboxes
/
{id}
JavaScript
import Moonbase from '@moonbaseai/sdk';

const client = new Moonbase({
  apiKey: process.env['MOONBASE_API_KEY'], // This is the default and can be omitted
});

const inbox = await client.inboxes.retrieve('id');

console.log(inbox.id);
{
  "id": "1CLJt2v17V1yuCdrUwA4PW",
  "type": "inbox",
  "name": "Test Inbox",
  "created_at": "2025-02-17T16:00:00.000Z",
  "updated_at": "2025-02-17T16:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Your Moonbase API key.

Path Parameters

​
id
string
required

The ID of the Inbox to retrieve.

Query Parameters

​
include[]
enum<string>[]

Specifies which related objects to include in the response. Valid option is tagsets.

Available options:
tagsets

Response

Successful response.

The Inbox object represents a shared inbox for receiving and sending messages.

​
type
string
required

String representing the object’s type. Always inbox for this object.

Allowed value: "inbox"
​
id
string
required

Unique identifier for the object.

​
name
string
required

The display name of the inbox.

​
created_at
string<date-time>
required

Time at which the object was created, as an ISO 8601 timestamp in UTC.

​
updated_at
string<date-time>
required

Time at which the object was last updated, as an ISO 8601 timestamp in UTC.

​
tagsets
Tagset · object[]

The list of Tagset objects associated with this inbox, which defines the tags available for its conversations.

Note: Only present when requested using the include query parameter.