List inboxes

Inboxes your account can open, with their folders.

GET https://cotlet.dev/api/v1/help-scout/inboxes

read

Returns every inbox you have access to, with the folders Help Scout shows for it, such as Unassigned, Mine, Assigned and Closed. Use the names it returns in search_conversations. Inboxes you cannot open are not listed.

Parameters

No parameters.

Request

cURL
curl https://cotlet.dev/api/v1/help-scout/inboxes \
  -H "Authorization: Bearer $COTLET_API_KEY"
Python
result = client.call("help-scout", "list_inboxes")
Node.js
const result = await cotlet.call('help-scout', 'list_inboxes');
CLI
cotlet call help-scout list_inboxes

Example response

JSON

{
  "inboxes": [
    {
      "name": "Support",
      "folders": [
        "Unassigned",
        "Mine",
        "Assigned",
        "Drafts",
        "Closed",
        "Spam"
      ]
    },
    {
      "name": "Sales",
      "folders": [
        "Unassigned",
        "Mine",
        "Assigned",
        "Closed",
        "Spam"
      ]
    }
  ]
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.