Skip to content
Developers/
Organization
/
/
userDetail

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

users

(...args)
UserListResponse

Paginated users list with filters for workspaces, departments, branches, status, and availability. Returns { list, totalCount } in a single response using paginateQuery.

Arguments

sortField
String
sortDirection
SortDirection
page
Int
perPage
Int
status
String
excludeIds
Boolean
searchValue
String
isActive
Boolean
requireUsername
Boolean
ids
[String]
workspaceIds
[String]
branchIds
[String]
departmentIds
[String]
availability
UserChatStatus

Return type

UserListResponse
data
[User]
pagination
PaginationInfo!,non-null
Query sample
query users(
  $sortField: String
  $sortDirection: SortDirection
  $page: Int
  $perPage: Int
  $status: String
  $excludeIds: Boolean
  $searchValue: String
  $isActive: Boolean
  $requireUsername: Boolean
  $ids: [String]
  $workspaceIds: [String]
  $branchIds: [String]
  $departmentIds: [String]
  $availability: UserChatStatus
) {
  users(
    sortField: $sortField
    sortDirection: $sortDirection
    page: $page
    perPage: $perPage
    status: $status
    excludeIds: $excludeIds
    searchValue: $searchValue
    isActive: $isActive
    requireUsername: $requireUsername
    ids: $ids
    workspaceIds: $workspaceIds
    branchIds: $branchIds
    departmentIds: $departmentIds
    availability: $availability
  ) {
    data {
      _id 
      createdAt 
      username 
      email 
      userPreferences 
      availability 
      isActive 
      details {
        __typename
        # ...UserDetailsTypeFragment
      }
      links 
      status 
      emailSignatures 
      groupIds 
      workspaceIds 
      isSubscribed 
      customFieldsData 
      workspaces {
        __typename
        # ...WorkspaceFragment
      }
      isOwner 
      permissionActions 
      configs 
      configsConstants 
      onboardingHistory {
        __typename
        # ...OnboardingHistoryFragment
      }
      departmentIds 
      departments {
        __typename
        # ...DepartmentFragment
      }
      branchIds 
      branches {
        __typename
        # ...BranchFragment
      }
      positionIds 
      positions {
        __typename
        # ...PositionFragment
      }
      score 
      scoreCategories {
        __typename
        # ...ScoreCategoriesFragment
      }
      leaderBoardPosition 
      employeeId 
      isOnline 
    }
    pagination {
      currentPage 
      perPage 
      totalCount 
      totalPages 
      hasNextPage 
      hasPreviousPage 
    }
  }
}
Variables
{
  "sortField": "Example String",
  "sortDirection": "asc",
  "page": 40,
  "perPage": 40,
  "status": "Example String",
  "excludeIds": true,
  "searchValue": "Example String",
  "isActive": true,
  "requireUsername": true,
  "ids": [
    "Example String"
  ],
  "workspaceIds": [
    "Example String"
  ],
  "branchIds": [
    "Example String"
  ],
  "departmentIds": [
    "Example String"
  ],
  "availability": "offline"
}
Response sample
{
  "data": {
    "data": [
      {
        "_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
      }
    ],
    "pagination": {
      "currentPage": 40,
      "perPage": 40,
      "totalCount": 40,
      "totalPages": 40,
      "hasNextPage": true,
      "hasPreviousPage": true
    }
  }
}

userDetail

(_id)
User

Load a single user with extended details by identifier.

Arguments

_id
String

Return type

User
_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
Query sample
query userDetail($_id: String) {
  userDetail(_id: $_id) {
    _id 
    createdAt 
    username 
    email 
    userPreferences 
    availability 
    isActive 
    details {
      avatar 
      coverPhoto 
      fullName 
      shortName 
      birthDate 
      position 
      workStartedDate 
      location 
      description 
      operatorPhone 
      firstName 
      lastName 
      employeeId 
    }
    links 
    status 
    emailSignatures 
    groupIds 
    workspaceIds 
    isSubscribed 
    customFieldsData 
    workspaces {
      _id 
      name 
      description 
      code 
      userId 
      createdAt 
      memberIds 
    }
    isOwner 
    permissionActions 
    configs 
    configsConstants 
    onboardingHistory {
      _id 
      userId 
      isCompleted 
      completedSteps 
      sections {
        __typename
        # ...OnboardingSectionsFragment
      }
      dismissedAt 
      firstLoginAt 
      lastActivityAt 
    }
    departmentIds 
    departments {
      _id 
      title 
      description 
      parentId 
      supervisorId 
      supervisor {
        __typename
        # ...UserFragment
      }
      code 
      order 
      parent {
        __typename
        # ...DepartmentFragment
      }
      children {
        __typename
        # ...DepartmentFragment
      }
      childCount 
      users {
        __typename
        # ...UserFragment
      }
      userCount 
      userIds 
    }
    branchIds 
    branches {
      _id 
      title 
      parentId 
      supervisorId 
      supervisor {
        __typename
        # ...UserFragment
      }
      code 
      order 
      users {
        __typename
        # ...UserFragment
      }
      userIds 
      userCount 
      parent {
        __typename
        # ...BranchFragment
      }
      children {
        __typename
        # ...BranchFragment
      }
      status 
      address 
      hasChildren 
    }
    positionIds 
    positions {
      _id 
      title 
      code 
      order 
      parentId 
      parent {
        __typename
        # ...PositionFragment
      }
      status 
      children {
        __typename
        # ...PositionFragment
      }
      users {
        __typename
        # ...UserFragment
      }
      userIds 
      userCount 
    }
    score 
    scoreCategories {
      speed {
        __typename
        # ...ScoreCategoryEntryFragment
      }
      quality {
        __typename
        # ...ScoreCategoryEntryFragment
      }
      productivity {
        __typename
        # ...ScoreCategoryEntryFragment
      }
      training {
        __typename
        # ...ScoreCategoryEntryFragment
      }
      engagement {
        __typename
        # ...ScoreCategoryEntryFragment
      }
    }
    leaderBoardPosition 
    employeeId 
    isOnline 
  }
}
Variables
{
  "_id": "Example String"
}
Response sample
{
  "data": {
    "_id": "Example String",
    "createdAt": "Example Custom Scalar",
    "username": "Example String",
    "email": "Example String",
    "userPreferences": "Example Custom Scalar",
    "availability": "offline",
    "isActive": true,
    "details": {
      "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"
    },
    "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": [
      {
        "_id": "Example String",
        "name": "Example String",
        "description": "Example String",
        "code": "Example String",
        "userId": "Example String",
        "createdAt": "Example Custom Scalar",
        "memberIds": [
          "Example String"
        ]
      }
    ],
    "isOwner": true,
    "permissionActions": "Example Custom Scalar",
    "configs": "Example Custom Scalar",
    "configsConstants": [
      "Example Custom Scalar"
    ],
    "onboardingHistory": {
      "_id": "Example String",
      "userId": "Example String",
      "isCompleted": true,
      "completedSteps": [
        "Example String"
      ],
      "sections": {
        "__typename": "OnboardingSections"
      },
      "dismissedAt": "Example Custom Scalar",
      "firstLoginAt": "Example Custom Scalar",
      "lastActivityAt": "Example Custom Scalar"
    },
    "departmentIds": [
      "Example String"
    ],
    "departments": [
      {
        "_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"
        ]
      }
    ],
    "branchIds": [
      "Example String"
    ],
    "branches": [
      {
        "_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
      }
    ],
    "positionIds": [
      "Example String"
    ],
    "positions": [
      {
        "_id": "Example String",
        "title": "Example String",
        "code": "Example String",
        "order": "Example String",
        "parentId": "Example String",
        "parent": {
          "__typename": "Position"
        },
        "status": "Example String",
        "children": [
          {
            "__typename": "Position"
          }
        ],
        "users": [
          {
            "__typename": "User"
          }
        ],
        "userIds": [
          "Example String"
        ],
        "userCount": 40
      }
    ],
    "score": 40,
    "scoreCategories": {
      "speed": {
        "__typename": "ScoreCategoryEntry"
      },
      "quality": {
        "__typename": "ScoreCategoryEntry"
      },
      "productivity": {
        "__typename": "ScoreCategoryEntry"
      },
      "training": {
        "__typename": "ScoreCategoryEntry"
      },
      "engagement": {
        "__typename": "ScoreCategoryEntry"
      }
    },
    "leaderBoardPosition": 40,
    "employeeId": "Example String",
    "isOnline": true
  }
}

departments

(...args)
DepartmentListQueryResponse

Paginated departments with optional status/parent filters, returns list + counts.

Arguments

ids
[String]
excludeIds
Boolean
perPage
Int
page
Int
searchValue
String
status
String
onlyFirstLevel
Boolean
parentId
String
withoutUserFilter
Boolean

Return type

DepartmentListQueryResponse
data
[Department]
pagination
PaginationInfo!,non-null
totalUsersCount
Int
Query sample
query departments(
  $ids: [String]
  $excludeIds: Boolean
  $perPage: Int
  $page: Int
  $searchValue: String
  $status: String
  $onlyFirstLevel: Boolean
  $parentId: String
  $withoutUserFilter: Boolean
) {
  departments(
    ids: $ids
    excludeIds: $excludeIds
    perPage: $perPage
    page: $page
    searchValue: $searchValue
    status: $status
    onlyFirstLevel: $onlyFirstLevel
    parentId: $parentId
    withoutUserFilter: $withoutUserFilter
  ) {
    data {
      _id 
      title 
      description 
      parentId 
      supervisorId 
      supervisor {
        __typename
        # ...UserFragment
      }
      code 
      order 
      parent {
        __typename
        # ...DepartmentFragment
      }
      children {
        __typename
        # ...DepartmentFragment
      }
      childCount 
      users {
        __typename
        # ...UserFragment
      }
      userCount 
      userIds 
    }
    pagination {
      currentPage 
      perPage 
      totalCount 
      totalPages 
      hasNextPage 
      hasPreviousPage 
    }
    totalUsersCount 
  }
}
Variables
{
  "ids": [
    "Example String"
  ],
  "excludeIds": true,
  "perPage": 40,
  "page": 40,
  "searchValue": "Example String",
  "status": "Example String",
  "onlyFirstLevel": true,
  "parentId": "Example String",
  "withoutUserFilter": true
}
Response sample
{
  "data": {
    "data": [
      {
        "_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"
        ]
      }
    ],
    "pagination": {
      "currentPage": 40,
      "perPage": 40,
      "totalCount": 40,
      "totalPages": 40,
      "hasNextPage": true,
      "hasPreviousPage": true
    },
    "totalUsersCount": 40
  }
}

departmentDetail

(_id)
Department

Arguments

_id
String!,non-nullrequired

Return type

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]
Query sample
query departmentDetail($_id: String!) {
  departmentDetail(_id: $_id) {
    _id 
    title 
    description 
    parentId 
    supervisorId 
    supervisor {
      _id 
      createdAt 
      username 
      email 
      userPreferences 
      availability 
      isActive 
      details {
        __typename
        # ...UserDetailsTypeFragment
      }
      links 
      status 
      emailSignatures 
      groupIds 
      workspaceIds 
      isSubscribed 
      customFieldsData 
      workspaces {
        __typename
        # ...WorkspaceFragment
      }
      isOwner 
      permissionActions 
      configs 
      configsConstants 
      onboardingHistory {
        __typename
        # ...OnboardingHistoryFragment
      }
      departmentIds 
      departments {
        __typename
        # ...DepartmentFragment
      }
      branchIds 
      branches {
        __typename
        # ...BranchFragment
      }
      positionIds 
      positions {
        __typename
        # ...PositionFragment
      }
      score 
      scoreCategories {
        __typename
        # ...ScoreCategoriesFragment
      }
      leaderBoardPosition 
      employeeId 
      isOnline 
    }
    code 
    order 
    parent {
      _id 
      title 
      description 
      parentId 
      supervisorId 
      supervisor {
        __typename
        # ...UserFragment
      }
      code 
      order 
      parent {
        __typename
        # ...DepartmentFragment
      }
      children {
        __typename
        # ...DepartmentFragment
      }
      childCount 
      users {
        __typename
        # ...UserFragment
      }
      userCount 
      userIds 
    }
    children {
      _id 
      title 
      description 
      parentId 
      supervisorId 
      supervisor {
        __typename
        # ...UserFragment
      }
      code 
      order 
      parent {
        __typename
        # ...DepartmentFragment
      }
      children {
        __typename
        # ...DepartmentFragment
      }
      childCount 
      users {
        __typename
        # ...UserFragment
      }
      userCount 
      userIds 
    }
    childCount 
    users {
      _id 
      createdAt 
      username 
      email 
      userPreferences 
      availability 
      isActive 
      details {
        __typename
        # ...UserDetailsTypeFragment
      }
      links 
      status 
      emailSignatures 
      groupIds 
      workspaceIds 
      isSubscribed 
      customFieldsData 
      workspaces {
        __typename
        # ...WorkspaceFragment
      }
      isOwner 
      permissionActions 
      configs 
      configsConstants 
      onboardingHistory {
        __typename
        # ...OnboardingHistoryFragment
      }
      departmentIds 
      departments {
        __typename
        # ...DepartmentFragment
      }
      branchIds 
      branches {
        __typename
        # ...BranchFragment
      }
      positionIds 
      positions {
        __typename
        # ...PositionFragment
      }
      score 
      scoreCategories {
        __typename
        # ...ScoreCategoriesFragment
      }
      leaderBoardPosition 
      employeeId 
      isOnline 
    }
    userCount 
    userIds 
  }
}
Variables
{
  "_id": "Example String"
}
Response sample
{
  "data": {
    "_id": "Example String",
    "title": "Example String",
    "description": "Example String",
    "parentId": "Example String",
    "supervisorId": "Example String",
    "supervisor": {
      "_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
    },
    "code": "Example String",
    "order": "Example String",
    "parent": {
      "_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"
      ]
    },
    "children": [
      {
        "_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"
        ]
      }
    ],
    "childCount": 40,
    "users": [
      {
        "_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
      }
    ],
    "userCount": 40,
    "userIds": [
      "Example String"
    ]
  }
}

branches

(...args)
BranchListQueryResponse

Paginated branches with optional status/parent filters, returns list + counts.

Arguments

ids
[String]
excludeIds
Boolean
perPage
Int
page
Int
searchValue
String
status
String
onlyFirstLevel
Boolean
parentId
String
withoutUserFilter
Boolean

Return type

BranchListQueryResponse
data
[Branch]
pagination
PaginationInfo!,non-null
totalUsersCount
Int
Query sample
query branches(
  $ids: [String]
  $excludeIds: Boolean
  $perPage: Int
  $page: Int
  $searchValue: String
  $status: String
  $onlyFirstLevel: Boolean
  $parentId: String
  $withoutUserFilter: Boolean
) {
  branches(
    ids: $ids
    excludeIds: $excludeIds
    perPage: $perPage
    page: $page
    searchValue: $searchValue
    status: $status
    onlyFirstLevel: $onlyFirstLevel
    parentId: $parentId
    withoutUserFilter: $withoutUserFilter
  ) {
    data {
      _id 
      title 
      parentId 
      supervisorId 
      supervisor {
        __typename
        # ...UserFragment
      }
      code 
      order 
      users {
        __typename
        # ...UserFragment
      }
      userIds 
      userCount 
      parent {
        __typename
        # ...BranchFragment
      }
      children {
        __typename
        # ...BranchFragment
      }
      status 
      address 
      hasChildren 
    }
    pagination {
      currentPage 
      perPage 
      totalCount 
      totalPages 
      hasNextPage 
      hasPreviousPage 
    }
    totalUsersCount 
  }
}
Variables
{
  "ids": [
    "Example String"
  ],
  "excludeIds": true,
  "perPage": 40,
  "page": 40,
  "searchValue": "Example String",
  "status": "Example String",
  "onlyFirstLevel": true,
  "parentId": "Example String",
  "withoutUserFilter": true
}
Response sample
{
  "data": {
    "data": [
      {
        "_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
      }
    ],
    "pagination": {
      "currentPage": 40,
      "perPage": 40,
      "totalCount": 40,
      "totalPages": 40,
      "hasNextPage": true,
      "hasPreviousPage": true
    },
    "totalUsersCount": 40
  }
}

branchDetail

(_id)
Branch

Arguments

_id
String!,non-nullrequired

Return type

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
Query sample
query branchDetail($_id: String!) {
  branchDetail(_id: $_id) {
    _id 
    title 
    parentId 
    supervisorId 
    supervisor {
      _id 
      createdAt 
      username 
      email 
      userPreferences 
      availability 
      isActive 
      details {
        __typename
        # ...UserDetailsTypeFragment
      }
      links 
      status 
      emailSignatures 
      groupIds 
      workspaceIds 
      isSubscribed 
      customFieldsData 
      workspaces {
        __typename
        # ...WorkspaceFragment
      }
      isOwner 
      permissionActions 
      configs 
      configsConstants 
      onboardingHistory {
        __typename
        # ...OnboardingHistoryFragment
      }
      departmentIds 
      departments {
        __typename
        # ...DepartmentFragment
      }
      branchIds 
      branches {
        __typename
        # ...BranchFragment
      }
      positionIds 
      positions {
        __typename
        # ...PositionFragment
      }
      score 
      scoreCategories {
        __typename
        # ...ScoreCategoriesFragment
      }
      leaderBoardPosition 
      employeeId 
      isOnline 
    }
    code 
    order 
    users {
      _id 
      createdAt 
      username 
      email 
      userPreferences 
      availability 
      isActive 
      details {
        __typename
        # ...UserDetailsTypeFragment
      }
      links 
      status 
      emailSignatures 
      groupIds 
      workspaceIds 
      isSubscribed 
      customFieldsData 
      workspaces {
        __typename
        # ...WorkspaceFragment
      }
      isOwner 
      permissionActions 
      configs 
      configsConstants 
      onboardingHistory {
        __typename
        # ...OnboardingHistoryFragment
      }
      departmentIds 
      departments {
        __typename
        # ...DepartmentFragment
      }
      branchIds 
      branches {
        __typename
        # ...BranchFragment
      }
      positionIds 
      positions {
        __typename
        # ...PositionFragment
      }
      score 
      scoreCategories {
        __typename
        # ...ScoreCategoriesFragment
      }
      leaderBoardPosition 
      employeeId 
      isOnline 
    }
    userIds 
    userCount 
    parent {
      _id 
      title 
      parentId 
      supervisorId 
      supervisor {
        __typename
        # ...UserFragment
      }
      code 
      order 
      users {
        __typename
        # ...UserFragment
      }
      userIds 
      userCount 
      parent {
        __typename
        # ...BranchFragment
      }
      children {
        __typename
        # ...BranchFragment
      }
      status 
      address 
      hasChildren 
    }
    children {
      _id 
      title 
      parentId 
      supervisorId 
      supervisor {
        __typename
        # ...UserFragment
      }
      code 
      order 
      users {
        __typename
        # ...UserFragment
      }
      userIds 
      userCount 
      parent {
        __typename
        # ...BranchFragment
      }
      children {
        __typename
        # ...BranchFragment
      }
      status 
      address 
      hasChildren 
    }
    status 
    address 
    hasChildren 
  }
}
Variables
{
  "_id": "Example String"
}
Response sample
{
  "data": {
    "_id": "Example String",
    "title": "Example String",
    "parentId": "Example String",
    "supervisorId": "Example String",
    "supervisor": {
      "_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
    },
    "code": "Example String",
    "order": "Example String",
    "users": [
      {
        "_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
      }
    ],
    "userIds": [
      "Example String"
    ],
    "userCount": 40,
    "parent": {
      "_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
    },
    "children": [
      {
        "_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
      }
    ],
    "status": "Example String",
    "address": "Example String",
    "hasChildren": true
  }
}

Objects

Overview

Enums

Overview
Other

Queries

Overview

Mutations

Overview

Objects

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview