Request

Response

    Queries

    hubs

    GraphQL: Query

    Retrieves all hubs that match the specified criteria.

    A Hub is a container of projects, shared resources, and users with a common context.

    Template for Query:

    query GetHubs($filter: HubFilterInput, $pagination: PaginationInput) {
      hubs(filter: $filter, pagination: $pagination) {
        # Hubs Fields
      }
    }
    

    Template for Query Variables:

    {
      "filter" : "<SOME-HUBFILTER-INPUT-TYPE-VALUE>",
      "pagination" : "<SOME-PAGINATION-INPUT-TYPE-VALUE>"
    }
    


    Arguments

    filterSpecifies how to filter a list of hubs. You can filter by ID or by name.
    paginationSpecifies how to split the response into multiple pages.

    Possible Returns

    Value TypeDescription
    Hubs! non-null Contains a list of hubs returned in response to a query. A hub is a container of projects, shared resources, and users with a common context.


    Examples

    Example 1

    Retrieves all hubs you have access to.

    Query:

    query GetHubs {
     hubs {
      results {
        id
        name
        }
      }
    }
    
    Show More

    Response:

    {
      "data": {
          "hubs": {
              "results": [
                  {
                      "id": "b.768cae14-76b3-4531-9030-25212dab4e48",
                      "name": "Construction Records Testing"
                  },
                  {
                      "id": "b.a9c78b5b-a9b4-4e8c-8c68-cbd8da758fc5",
                      "name": "FDX EMEA"
                  }
              ]
          }
       }
    }
    
    Show More