superAdminCompanies | BigCommerce Developer Center

query ExampleQuery($superAdminId: Int, $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $search: String, $orderBy: String) {
  superAdminCompanies(superAdminId: $superAdminId, offset: $offset, before: $before, after: $after, first: $first, last: $last, search: $search, orderBy: $orderBy) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node
      cursor
    }
    totalCount
  }
}

{
  "superAdminId": 0,
  "offset": 0,
  "before": "example",
  "after": "example",
  "first": 0,
  "last": 0,
  "search": "example",
  "orderBy": "example"
}

{
  "data": {
    "superAdminCompanies": {
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example",
        "endCursor": "example"
      },
      "edges": [
        {
          "node": {
            "companyId": null,
            "id": null,
            "companyName": null,
            "bcGroupName": null,
            "companyAdminName": null,
            "companyEmail": null,
            "extraFields": null
          },
          "cursor": "example"
        }
      ],
      "totalCount": 0
    }
  }
}

Get a list of companies by super admin. Requires a B2B token.

Arguments

superAdminIdIntegerRequired

Unique ID of a super admin. This field is required.

offsetIntegerOptional

beforeStringOptional

afterStringOptional

firstIntegerOptional

lastIntegerOptional

searchStringOptional

orderByStringOptional

Ordering

Returns

an optional Object

pageInfoObject

Pagination data for this connection.

edgeslist of Objects

totalCountInteger

A total count of items in the collection.