Skip to main content
GET
/
inbox_conversations
JavaScript
import Moonbase from '@moonbaseai/sdk';

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

// Automatically fetches more pages as needed.
for await (const inboxConversation of client.inboxConversations.list()) {
  console.log(inboxConversation.id);
}
{
  "type": "list",
  "data": [
    {
      "id": "1CLJt2v1cFRDidcZsXKEd4",
      "type": "inbox_conversation",
      "created_at": "2025-02-17T16:00:00.000Z",
      "updated_at": "2025-02-17T16:00:00.000Z",
      "tags": [],
      "subject": "subject",
      "last_message_at": "2025-02-17T16:00:00.000Z",
      "state": "unassigned",
      "follow_up": false,
      "unread": false,
      "bulk": false,
      "spam": false,
      "trash": false,
      "draft": false
    },
    {
      "id": "1CLJt2v3bK2AzMXRRswwZG",
      "type": "inbox_conversation",
      "created_at": "2025-02-17T16:00:00.000Z",
      "updated_at": "2025-02-17T16:00:00.000Z",
      "tags": [],
      "subject": "subject",
      "last_message_at": "2025-02-17T16:00:00.000Z",
      "state": "unassigned",
      "follow_up": false,
      "unread": false,
      "bulk": false,
      "spam": false,
      "trash": false,
      "draft": false
    },
    {
      "id": "1CLJt2v5aNd8G5SGzEaeVU",
      "type": "inbox_conversation",
      "created_at": "2025-02-17T16:00:00.000Z",
      "updated_at": "2025-02-17T16:00:00.000Z",
      "tags": [],
      "subject": "subject",
      "last_message_at": "2025-02-17T16:00:00.000Z",
      "state": "unassigned",
      "follow_up": false,
      "unread": false,
      "bulk": false,
      "spam": false,
      "trash": false,
      "draft": false
    }
  ],
  "meta": {
    "cursors": {}
  }
}

Authorizations

​
Authorization
string
header
required

Your Moonbase API key.

Query Parameters

​
before
string

When specified, returns results starting immediately before the item identified by this cursor. Use the cursor value from the response's metadata to fetch the previous page of results.

​
after
string

When specified, returns results starting immediately after the item identified by this cursor. Use the cursor value from the previous response's metadata to fetch the next page of results.

​
limit
integer
default:20

Maximum number of items to return per page. Must be between 1 and 100. Defaults to 20 if not specified.

Required range: 1 <= x <= 100
​
include[]
enum<string>[]

Specifies which related objects to include in the response. Valid options are inbox, messages, and messages.addresses.

Available options:
inbox,
messages,
messages.addresses
​
filter
object

Response

Successful response.

A set of results using cursor-based pagination.

​
type
string
required
Allowed value: "list"
​
data
InboxConversation · object[]
required

An array of InboxConversation items.

​
meta
object
required

Metadata about the pagination, including the cursors pointing to the previous and next pages.