Reference Accounts by GroupId object

Use the Reference Accounts by GroupId object to return all of the accessible accounts in the provided account group. You can also search for a specific account that matches a string input.

You must have the API Access privilege to use this object.

Structure

referenceAccountsbyGroupId(groupID: ""
    accountSearch:{
        searchStringOperator: CONTAINS,
        argument: "string"
    })
    {
        id
        name
    }

Field	Type	Description
groupId	string	The account group ID.
searchStringOperator	operator	The search operator for how you want to match accounts in the account group. You can set this variable to CONTAINS or STARTSWITH.
argument	string	The criteria by which you want to search for matching accounts.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE

GraphQL implementation

Send an HTTP POST to https://platform.boomi.com/graphql

The following example shows a request to return all accessible accounts in the provided account group:

For a JSON request, send the request with the HTTP header Content-Type: application/json.

Request

query {
    referenceAccountsByGroupId(groupId: "01b12345-cd1e-474d-aeff-16779609436d"){
        id
        name
    }
}

For a JSON response, send the request with the HTTP header Accept: application/json.

Response:

{
    "data": {
        "referenceAccountsByGroupId": [
            {
                "id": "account1-ABCDE",
                "name": "Account-A"
            },
            {
                "id": "account2-FGHIJ",
                "name": "Account-B"
            },
            {
                "id": "account3-KLMNO",
                "name": "Account-C"
            },
            {
                "id": "account4-PQRST",
                "name": "Account-D"
            },
            {
                "id": "account5-UVWXY",
                "name": "Account-E"
            }
        ]
    }
}

The following example shows a request to return all accessible accounts in a given account group that contain a specific string:

For a JSON request, send the request with the HTTP header Content-Type: application/json.

Request

query {
   referenceAccountsByGroupId(groupId: "01b12345-cd1e-474d-aeff-16779609436d",
   accountSearch: {
       searchStringOperator: CONTAINS,
       argument: "Account-A"
   }){
       id
       name
   }
}

For a JSON response, send the request with the HTTP header Accept: application/json.

Response

{
    "data": {
        "referenceAccountsByGroupId": [
            {
                "id": "account1-ABCDE",
                "name": "Account-A"
            }
        ]
    }
}

The following example shows a request to return all accessible accounts in an account group that start with a specific string:

For a JSON request, send the request with the HTTP header Content-Type: application/json.

Request

query {
   referenceAccountsByGroupId(groupId: "01b12345-cd1e-474d-aeff-16779609436d",
   accountSearch: {
       searchStringOperator: STARTSWITH,
       argument: "Account-A"
   }){
       id
       name
   }
}

For a JSON response, send the request with the HTTP header Accept: application/json.

Response

{
    "data": {
        "referenceAccountsByGroupId": [
            {
                "id": "account1-ABCDE",
                "name": "Account-A"
            },
            {
                "id": "account1-ABCDE",
                "name": "Account-A2"
            },
            {
                "id": "account2-FGHIJ",
                "name": "Account-A9"
            }
        ]
    }
}