Skip to content
Developers/
Organization
/
/
BranchListQueryResponse

GraphQL Overview

Browse queries, mutations, and types in the schema reference. For authentication, endpoint URLs, and domain guides, see the API Overview.

Conversations & messaging

Queries

Overview

Mutations

Overview

Objects

Overview

Enums

Overview
Contacts & CRM

Queries

Overview

Mutations

Overview

Objects

Overview

Inputs

Overview
Products & commerce

Queries

Overview

Mutations

Overview

Objects

Overview
Apps & credentials

Queries

Overview

Mutations

Overview

Objects

Overview
Organization

Queries

Overview

Objects

Overview

Branch

_id
String!,non-null
title
String
parentId
String
supervisorId
String
supervisor
User
code
String
order
String
users
[User]
userIds
[String]
userCount
Int
parent
Branch
children
[Branch]
status
String
address
String
hasChildren
Boolean
Sample
{
  "_id": "Example String",
  "title": "Example String",
  "parentId": "Example String",
  "supervisorId": "Example String",
  "supervisor": {
    "__typename": "User"
  },
  "code": "Example String",
  "order": "Example String",
  "users": [
    {
      "__typename": "User"
    }
  ],
  "userIds": [
    "Example String"
  ],
  "userCount": 40,
  "parent": {
    "__typename": "Branch"
  },
  "children": [
    {
      "__typename": "Branch"
    }
  ],
  "status": "Example String",
  "address": "Example String",
  "hasChildren": true
}
Referenced in
Branch.parent
Branch.children
BranchListQueryResponse.data
User.branches

BranchListQueryResponse

data
[Branch]
pagination
PaginationInfo!,non-null
totalUsersCount
Int
Sample
{
  "data": [
    {
      "__typename": "Branch"
    }
  ],
  "pagination": {
    "__typename": "PaginationInfo"
  },
  "totalUsersCount": 40
}

Department

_id
String!,non-null
title
String
description
String
parentId
String
supervisorId
String
supervisor
User
code
String
order
String
parent
Department
children
[Department]
childCount
Int
users
[User]
userCount
Int
userIds
[String]
Sample
{
  "_id": "Example String",
  "title": "Example String",
  "description": "Example String",
  "parentId": "Example String",
  "supervisorId": "Example String",
  "supervisor": {
    "__typename": "User"
  },
  "code": "Example String",
  "order": "Example String",
  "parent": {
    "__typename": "Department"
  },
  "children": [
    {
      "__typename": "Department"
    }
  ],
  "childCount": 40,
  "users": [
    {
      "__typename": "User"
    }
  ],
  "userCount": 40,
  "userIds": [
    "Example String"
  ]
}
Referenced in
AssignedPayload.assignedDepartment
Conversation.assignedDepartment
Department.parent
Department.children
DepartmentListQueryResponse.data
Integration.department
UnassignedPayload.assignedDepartment
User.departments

DepartmentListQueryResponse

data
[Department]
pagination
PaginationInfo!,non-null
totalUsersCount
Int
Sample
{
  "data": [
    {
      "__typename": "Department"
    }
  ],
  "pagination": {
    "__typename": "PaginationInfo"
  },
  "totalUsersCount": 40
}

User

Team member account with permissions, preferences, and structure assignments.

_id
String!,non-null
createdAt
Date
username
String
email
String
userPreferences
JSON
availability
UserChatStatus
isActive
Boolean
details
UserDetailsType
links
JSON
status
String
emailSignatures
JSON
groupIds
[String]
workspaceIds
[String]
isSubscribed
String
customFieldsData
JSON
workspaces
[Workspace]
isOwner
Boolean
permissionActions
JSON
configs
JSON
configsConstants
[JSON]
onboardingHistory
OnboardingHistory
departmentIds
[String]
departments
[Department]
branchIds
[String]
branches
[Branch]
positionIds
[String]
positions
[Position]
score
Float
scoreCategories
ScoreCategories
leaderBoardPosition
Int
employeeId
String
isOnline
Boolean
Sample
{
  "_id": "Example String",
  "createdAt": "Example Custom Scalar",
  "username": "Example String",
  "email": "Example String",
  "userPreferences": "Example Custom Scalar",
  "availability": "offline",
  "isActive": true,
  "details": {
    "__typename": "UserDetailsType"
  },
  "links": "Example Custom Scalar",
  "status": "Example String",
  "emailSignatures": "Example Custom Scalar",
  "groupIds": [
    "Example String"
  ],
  "workspaceIds": [
    "Example String"
  ],
  "isSubscribed": "Example String",
  "customFieldsData": "Example Custom Scalar",
  "workspaces": [
    {
      "__typename": "Workspace"
    }
  ],
  "isOwner": true,
  "permissionActions": "Example Custom Scalar",
  "configs": "Example Custom Scalar",
  "configsConstants": [
    "Example Custom Scalar"
  ],
  "onboardingHistory": {
    "__typename": "OnboardingHistory"
  },
  "departmentIds": [
    "Example String"
  ],
  "departments": [
    {
      "__typename": "Department"
    }
  ],
  "branchIds": [
    "Example String"
  ],
  "branches": [
    {
      "__typename": "Branch"
    }
  ],
  "positionIds": [
    "Example String"
  ],
  "positions": [
    {
      "__typename": "Position"
    }
  ],
  "score": 40,
  "scoreCategories": {
    "__typename": "ScoreCategories"
  },
  "leaderBoardPosition": 40,
  "employeeId": "Example String",
  "isOnline": true
}
Referenced in
AssignedPayload.assignedToUser
AssignedPayload.assignedUser
AssignedPayload.assignedByUser
AssignedPayload.performedByUser
Branch.supervisor
Branch.users
Company.owner
Conversation.user
Conversation.assignedUser
Conversation.participatedUsers
Conversation.readUsers
ConversationMessage.user
ConvertedToCardPayload.performedByUser
Customer.owner
Department.supervisor
Department.users
Field.lastUpdatedUser
FieldsGroup.lastUpdatedUser
Form.createdUser
KnowledgeBaseArticle.createdUser
KnowledgeBaseArticle.publishedUser
KnowledgeBaseCategory.authors
KnowledgeBaseParentCategory.authors
ParticipantAddedPayload.addedUser
ParticipantAddedPayload.addedUsers
ParticipantRemovedPayload.removedUsers
ParticipantRemovedPayload.performedByUser
Position.users
StatusChangedPayload.performedByUser
TagsChangedPayload.performedByUser
UnassignedPayload.assignedToUser
UnassignedPayload.assignedUser
UnassignedPayload.assignedByUser
UnassignedPayload.performedByUser
UserListResponse.data

UserDetailsType

avatar
String

Profile avatar URL.

coverPhoto
String

Cover photo or header background.

fullName
String

Full display name used in the UI.

shortName
String

Short name or nickname.

birthDate
Date

Birth date; used for anniversaries.

position
String

Job title or position.

workStartedDate
Date

Employment start date.

location
String

Primary working location.

description
String

Short bio or description.

operatorPhone
String

Direct phone number for operators.

firstName
String

Given name.

lastName
String

Family name.

employeeId
String

Internal employee identifier.

Sample
{
  "avatar": "Example String",
  "coverPhoto": "Example String",
  "fullName": "Example String",
  "shortName": "Example String",
  "birthDate": "Example Custom Scalar",
  "position": "Example String",
  "workStartedDate": "Example Custom Scalar",
  "location": "Example String",
  "description": "Example String",
  "operatorPhone": "Example String",
  "firstName": "Example String",
  "lastName": "Example String",
  "employeeId": "Example String"
}
Referenced in
User.details

UserListResponse

Paginated response wrapper for user list queries.

data
[User]
pagination
PaginationInfo!,non-null
Sample
{
  "data": [
    {
      "__typename": "User"
    }
  ],
  "pagination": {
    "__typename": "PaginationInfo"
  }
}

Workspace

Workspace entity used for multi-workspace configurations (email, assets, member assignments).

_id
String!,non-null
name
String
description
String
code
String
userId
String
createdAt
Date
memberIds
[String]
Sample
{
  "_id": "Example String",
  "name": "Example String",
  "description": "Example String",
  "code": "Example String",
  "userId": "Example String",
  "createdAt": "Example Custom Scalar",
  "memberIds": [
    "Example String"
  ]
}
Referenced in
Form.workspace
Integration.workspace
KnowledgeBaseTopic.workspace
User.workspaces

Enums

Overview
Other

Queries

Overview

Mutations

Overview

Objects

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview