Get Root Groups

post

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

Use the Get Root Groups endpoint to retrieve all of the root groups within a core. 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.

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"

page

int32 | null

1 to 999999

The number of the page to retrieve.
Pattern: Integer value of 1 or greater
Example: 3

recordCnt

int32

1 to 99999

The maximum number of records per page to be returned.
Pattern: Positive integer 1-99999
Example: 100

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