portfolioByReference
Get details about a portfolio, using its reference.
Arguments
Portfolio reference namespace-value pair to filter by.
Possible Errors
Allowed Viewers
Customer
Partner User
Third party
Required Permissions
Can access customer queriesCan query portfolios
Query Complexity
2Examples
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
query PortfolioByReference($portfolioReference: PortfolioReferenceInput!) {
portfolioByReference(portfolioReference: $portfolioReference) {
accounts {
...AccountConnectionTypeConnectionFragment
}
ancestors {
...PortfolioConnectionTypeConnectionFragment
}
billingName
brand
collectiveBilling
createdAt
depth
descendants {
...PortfolioConnectionTypeConnectionFragment
}
id
leadAccountNumber
name
number
operationsTeam {
...OperationsTeamTypeFragment
}
parent {
...PortfolioTypeFragment
}
updatedAt
}
}
Variables
{
"portfolioReference": PortfolioReferenceInput
}
Response
{
"data": {
"portfolioByReference": {
"accounts": AccountConnectionTypeConnection,
"ancestors": PortfolioConnectionTypeConnection,
"billingName": "world-always-mother-kitchen-campaign",
"brand": "house-remain-think-agency-modern",
"collectiveBilling": true,
"createdAt": "1975-02-11T18:16:31.036683+00:00",
"depth": 42,
"descendants": PortfolioConnectionTypeConnection,
"id": "21513905",
"leadAccountNumber": "A-B5B3A062",
"name": "few-teacher-around-end-same",
"number": "employee-herself-bring-question-behind",
"operationsTeam": OperationsTeamType,
"parent": PortfolioType,
"updatedAt": "2017-08-10T10:50:57.284580+00:00"
}
}
}