Karzoun Docs

QUERY

branches(ids: [String], excludeIds: Boolean, perPage: Int, page: Int, searchValue: String, status: String, onlyFirstLevel: Boolean, parentId: String, withoutUserFilter: Boolean): BranchListQueryResponse

Arguments

ids

[String]

Restrict to these branch ids.

excludeIds

Boolean

When true, ids excludes instead of includes.

perPage

Int

Page size. See Pagination.

page

Int

1-based page index. See Pagination.

searchValue

String

Case-insensitive partial match on title.

status

String

Filter by lifecycle status.

onlyFirstLevel

Boolean

When true, only return top-level branches (no parentId).

parentId

String

Restrict to direct children of this branch id.

withoutUserFilter

Boolean

When true, skip filtering branches by the caller's user scope.

Returns

BranchListQueryResponse

data

[Branch]

Branch rows for the current page.

pagination

PaginationInfo!

Standard pagination metadata: totalCount, currentPage, totalPages, hasNextPage, hasPreviousPage, perPage.

totalUsersCount

Int

Total number of users across all matching branches.

Query

query Branches {
  branches {
    data {
      _id
      title
      parentId
      supervisorId
      supervisor {
        _id
        createdAt
        username
        email
        userPreferences
        availability
      }
      code
    }
    pagination {
      currentPage
      perPage
      totalCount
      totalPages
      hasNextPage
      hasPreviousPage
    }
    totalUsersCount
  }
}

Response

{
  "data": {
    "branches": {
      "data": [
        {
          "_id": "string",
          "title": "string",
          "parentId": "string",
          "supervisorId": "string",
          "supervisor": {
            "_id": "string",
            "createdAt": "value",
            "username": "string",
            "email": "string",
            "userPreferences": "value",
            "availability": "offline"
          },
          "code": "string"
        }
      ],
      "pagination": {
        "currentPage": 1,
        "perPage": 1,
        "totalCount": 1,
        "totalPages": 1,
        "hasNextPage": true,
        "hasPreviousPage": true
      },
      "totalUsersCount": 1
    }
  }
}

آخر تعديل في ١١ أغسطس ٢٠٢٦

Query

query Branches {
  branches {
    data {
      _id
      title
      parentId
      supervisorId
      supervisor {
        _id
        createdAt
        username
        email
        userPreferences
        availability
      }
      code
    }
    pagination {
      currentPage
      perPage
      totalCount
      totalPages
      hasNextPage
      hasPreviousPage
    }
    totalUsersCount
  }
}

Response

{
  "data": {
    "branches": {
      "data": [
        {
          "_id": "string",
          "title": "string",
          "parentId": "string",
          "supervisorId": "string",
          "supervisor": {
            "_id": "string",
            "createdAt": "value",
            "username": "string",
            "email": "string",
            "userPreferences": "value",
            "availability": "offline"
          },
          "code": "string"
        }
      ],
      "pagination": {
        "currentPage": 1,
        "perPage": 1,
        "totalCount": 1,
        "totalPages": 1,
        "hasNextPage": true,
        "hasPreviousPage": true
      },
      "totalUsersCount": 1
    }
  }
}

البداية

أدلة

جرّب

Queries

Mutations

Types

branches

Arguments

Returns