For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
          • QUERYcompanyRoles
          • QUERYcompanyRole
          • QUERYcompanyPermissions
          • QUERYaccountSettings
          • QUERYcustomerAccountSettings
          • QUERYinvoices
          • QUERYinvoice
          • QUERYinvoiceStats
          • QUERYinvoiceCustomerInformation
          • QUERYinvoicePaymentModules
          • QUERYinvoiceBcOrderAllowMethods
          • QUERYinvoicePaymentBcCart
          • QUERYinvoicePaymentFees
          • QUERYreceipts
          • QUERYreceipt
          • QUERYallReceiptLines
          • QUERYreceiptLine
          • QUERYreceiptLines
          • QUERYorder
          • QUERYallOrders
          • QUERYorderProducts
          • QUERYorderedProducts
          • QUERYcustomerOrders
          • QUERYcustomerOrder
          • QUERYcreatedByUser
          • QUERYshoppingLists
          • QUERYshoppingList
          • QUERYshoppingListsIdName
          • QUERYcustomerShoppingLists
          • QUERYcustomerShoppingList
          • QUERYcustomerShoppingListsIdName
          • QUERYcompanyExtraFields
          • QUERYuserCompany
          • QUERYcompanyValidateEmail
          • QUERYcompanyUserInfo
          • QUERYaccountFormFields
          • QUERYcompanyCreditConfig
          • QUERYcompanyPaymentTerms
          • QUERYcompanySubsidiaries
          • QUERYsuperAdminCompanies
          • QUERYsuperAdminMasquerading
          • QUERYquotes
          • QUERYcustomerQuotes
          • QUERYquote
          • QUERYquoteUserStoreInfo
          • QUERYquoteConfig
          • QUERYquoteExtraFieldsConfig
          • QUERYusers
          • QUERYuser
          • QUERYuserEmailCheck
          • QUERYcustomerEmailCheck
          • QUERYuserExtraFields
          • QUERYcurrentUser
          • QUERYcustomerInfo
          • QUERYuserLoginState
          • QUERYuserMasqueradingCompany
          • QUERYorderStatuses
          • QUERYbcOrderStatuses
          • QUERYcurrencies
          • QUERYautoLoader
          • QUERYstoreLimitations
          • QUERYstoreBasicInfo
          • QUERYstorefrontScript
          • QUERYstorefrontDefaultLanguage
          • QUERYstorefrontProductSettings
          • QUERYstorefrontSettings
          • QUERYstoreConfigSwitchStatus
          • QUERYstoreCheckoutConfig
          • QUERYstorefrontConfig
          • QUERYstorefrontConfigs
          • QUERYproductVariantsInfo
          • QUERYvariantSku
          • QUERYproductsInventory
          • QUERYproductsLoad
          • QUERYproductsSearch
          • QUERYtaxZoneRates
          • QUERYproductPurchasable
          • QUERYvalidateProduct
          • QUERYvalidateProducts
          • QUERYpriceProducts
          • QUERYaddresses
          • QUERYaddress
          • QUERYcountries
          • QUERYdefaultShippingAddress
          • QUERYdefaultBillingAddress
          • QUERYcustomerAddresses
          • QUERYcustomerAddress
          • QUERYaddressConfig
          • QUERYaddressExtraFields
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLB2BQueries

superAdminCompanies

Example Query
1query ExampleQuery($superAdminId: Int, $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $search: String, $orderBy: String) {
2 superAdminCompanies(superAdminId: $superAdminId, offset: $offset, before: $before, after: $after, first: $first, last: $last, search: $search, orderBy: $orderBy) {
3 pageInfo {
4 hasNextPage
5 hasPreviousPage
6 startCursor
7 endCursor
8 }
9 edges {
10 node
11 cursor
12 }
13 totalCount
14 }
15}
Variables
1{
2 "superAdminId": 0,
3 "offset": 0,
4 "before": "example",
5 "after": "example",
6 "first": 0,
7 "last": 0,
8 "search": "example",
9 "orderBy": "example"
10}
Example response
1{
2 "data": {
3 "superAdminCompanies": {
4 "pageInfo": {
5 "hasNextPage": true,
6 "hasPreviousPage": true,
7 "startCursor": "example",
8 "endCursor": "example"
9 },
10 "edges": [
11 {
12 "node": {
13 "companyId": null,
14 "id": null,
15 "companyName": null,
16 "bcGroupName": null,
17 "companyAdminName": null,
18 "companyEmail": null,
19 "extraFields": null
20 },
21 "cursor": "example"
22 }
23 ],
24 "totalCount": 0
25 }
26 }
27}
Get a list of companies by super admin. Requires a B2B token.
Was this page helpful?
Previous

companySubsidiaries

Next

superAdminMasquerading

Built with

Arguments

superAdminIdIntegerRequired
Unique ID of a super admin. This field is required.
offsetIntegerOptional
beforeStringOptional
afterStringOptional
firstIntegerOptional
lastIntegerOptional
searchStringOptional
orderByStringOptional
Ordering

Returns

an optional SuperAdminCompanyTypeCountableConnection
pageInfoPageInfo
Pagination data for this connection.
edgeslist of SuperAdminCompanyTypeCountableEdges
totalCountInteger
A total count of items in the collection.