Skip to main content
GET
/
inboxes
/
{inboxId}
JavaScript
import Nuntly from '@nuntly/sdk';

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

const inboxDetail = await client.inboxes.retrieve('ibx_01kabn43yqyxn2bx4ve84mczd3');

console.log(inboxDetail.id);
{
  "data": {
    "id": "<string>",
    "createdAt": "<string>",
    "domainId": "<string>",
    "domainName": "<string>",
    "address": "<string>",
    "name": "<string>",
    "namespaceId": "<string>",
    "namespaceName": "<string>",
    "status": "active",
    "agentId": "<string>",
    "totalThreads": 123,
    "unreadThreads": 123,
    "updatedAt": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer HTTP authentication. Allowed headers Authorization: Bearer <API_KEY>

Path Parameters

inboxId
string
required

The id of the inbox

Example:

"ibx_01kabn43yqyxn2bx4ve84mczd3"

Response

Successful response.

data
object
required