Inboxes

The inboxes endpoint provides a summary view of conversations grouped by assignment status, users, and teams. This helps you understand conversation distribution and workload across your workspace.

GET/app/inboxes

List Inboxes

Retrieve inbox statistics including conversation counts grouped by assignment status (assigned to me, unassigned, all), individual users, and teams. Results are filtered by conversation status.

Query Parameters

Name
status
Type
string
Required
*
Description
Conversation status to filter by: open, closed, or snoozed.

Request

GET

/app/inboxes

curl "https://api.pipeback.com/app/inboxes?status=open" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID"

Response

{
  "inbox": [
    {
      "name": "assigned_to_me",
      "total": 5,
      "user": {
        "id": "9d5f3d04-2c61-4d1a-8a3e-1b2c3d4e5f6a",
        "name": "John Doe",
        "photo": "https://example.com/photos/john.jpg"
      }
    },
    {
      "name": "unassigned",
      "total": 12
    },
    {
      "name": "all",
      "total": 47
    }
  ],
  "users": [
    {
      "name": "John Doe",
      "total": 5,
      "user": {
        "id": "9d5f3d04-2c61-4d1a-8a3e-1b2c3d4e5f6a",
        "name": "John Doe",
        "photo": "https://example.com/photos/john.jpg"
      }
    },
    {
      "name": "Jane Smith",
      "total": 8,
      "user": {
        "id": "9d5f3d04-2c61-4d1a-8a3e-1b2c3d4e5f6b",
        "name": "Jane Smith",
        "photo": "https://example.com/photos/jane.jpg"
      }
    },
    {
      "name": "Bob Wilson",
      "total": 3,
      "user": {
        "id": "9d5f3d04-2c61-4d1a-8a3e-1b2c3d4e5f6c",
        "name": "Bob Wilson",
        "photo": "https://example.com/photos/bob.jpg"
      }
    }
  ],
  "teams": [
    {
      "name": "Support Team",
      "total": 15,
      "team": {
        "id": "9d5f3d04-4e5f-6g7h-8i9j-0k1l2m3n4o5a",
        "icon": "headset"
      }
    },
    {
      "name": "Sales Team",
      "total": 10,
      "team": {
        "id": "9d5f3d04-4e5f-6g7h-8i9j-0k1l2m3n4o5b",
        "icon": "briefcase"
      }
    }
  ]
}

Response Structure

The response is divided into three main sections:

Inbox Section

Special inbox categories showing conversation counts:

Name
assigned_to_me
Description
Conversations assigned to the authenticated user. Includes user object with id, name, and photo.
Name
unassigned
Description
Conversations not assigned to any user or team (both user_id and team_id are null).
Name
all
Description
Total count of all conversations in the workspace for the specified status.

Users Section

Array of workspace users with their conversation counts:

Name
name
Type
string
Description
User's full name.
Name
total
Type
integer
Description
Number of conversations assigned to this user with the specified status.
Name
user
Type
object
Description
User object containing id, name, and photo URL.

Teams Section

Array of workspace teams with their conversation counts:

Name
name
Type
string
Description
Team name.
Name
total
Type
integer
Description
Number of conversations assigned to this team with the specified status.
Name
team
Type
object
Description
Team object containing id and icon.

Conversation Statuses

The status parameter filters conversations by their current state:

Name
open
Description
Active conversations requiring attention.
Name
closed
Description
Resolved conversations that have been closed.
Name
snoozed
Description
Conversations that are temporarily hidden until a later time.

Assignment Logic

Conversations can be assigned in different ways:

User Assignment: Conversation has a user_id set
Team Assignment: Conversation has a team_id set
Unassigned: Both user_id and team_id are null

The counts reflect conversations filtered by the specified status. For example, with status=open, all counts represent only open conversations.