List a user's email inboxes

curl --request GET \
  --url https://core-api.getaptly.com/api/users/{userId}/inboxes \
  --header 'x-token: <api-key>'

{
  "data": [
    {
      "_id": "ch_abc",
      "channelId": "acc-1",
      "type": "Hermes",
      "provider": "google",
      "email": "[email protected]",
      "name": "Alice's Inbox",
      "kind": "personal"
    },
    {
      "_id": "ch_def",
      "channelId": "acc-2",
      "type": "Hermes",
      "provider": "google",
      "email": "[email protected]",
      "name": "Leasing Team",
      "kind": "shared"
    }
  ]
}

Users

List a user's email inboxes

Returns the email inboxes (Hermes/Nylas channels) accessible to the given user within your company. Includes personal inboxes (where the user is a direct member) and shared inboxes the user can access via team membership.

Each inbox is tagged kind: "personal" (isShared is false and the user is in the channel’s userIds) or kind: "shared" (channel marked isShared, or accessible only through a team membership).

The user must belong to the company associated with your API key. Returns 401 if the user does not belong to your company.

GET

api

users

{userId}

inboxes

List a user's email inboxes

curl --request GET \
  --url https://core-api.getaptly.com/api/users/{userId}/inboxes \
  --header 'x-token: <api-key>'

{
  "data": [
    {
      "_id": "ch_abc",
      "channelId": "acc-1",
      "type": "Hermes",
      "provider": "google",
      "email": "[email protected]",
      "name": "Alice's Inbox",
      "kind": "personal"
    },
    {
      "_id": "ch_def",
      "channelId": "acc-2",
      "type": "Hermes",
      "provider": "google",
      "email": "[email protected]",
      "name": "Leasing Team",
      "kind": "shared"
    }
  ]
}

Authorizations

x-token

string

header

required

Path Parameters

userId

string

required

The user's ID.

Response

List of inboxes accessible to the user.

data

object[]

Show child attributes

List users List unsent drafts on an inbox

Documentation Index

Authorizations

Path Parameters

Response