Get Account Group Relationships

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/getAccountGroupRelationships

Use the Get Account Group Relationships endpoint to retrieve all accounts that are in a group, either in a single group or in all associated subgroups. See Creating a Corporate Hierarchy for instructions on using this endpoint.

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
618-01	Invalid group ID. The `groupId` does not exist in the core. Verify that `groupId` is correct by calling Get Group Hierarchy for the root group.

Form Data

apiLogin

string

required

Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Your unique provider identifier from SoFi Tech Solutions.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

groupId

string

required

length between 1 and 10

^[\d]+$

Identifier of the group (group_id) as returned by the Create Group endpoint.
Pattern: Max 10 numeric characters
Example: "4522"

includeSubGroups

string | null

enum

Whether to retrieve accounts that are in the subgroups of groupId. Default: "N"
Pattern: String
Example: "Y"

Allowed:

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Status codes

default