Role info by fund ID

Request

Returns the authenticated user's party roles for a specific fund, identified by its unique fund ID (GUID).

Party roles represent the user's relationship to the fund (e.g. ADVISOR, ADMIN, TRUSTINDIVIDUAL, TRUSTCORPORATE, MEMBER). A user can hold multiple party roles on the same fund.

The fund ID (GUID) can be obtained from the fund-data/fund-list endpoint response.

An empty PartyRoles array indicates that the authenticated user is not set up as a related party on the specified fund.

Security

Class_oAuth

Query

fundIdstring, (uuid)required

The unique identifier (GUID) of the fund. This can be obtained from the fund-data/fund-list endpoint.

Example:fundId=fffa6ce3-48b6-484b-aaf6-2a2ba5563646

curl -i -X GET \
  'https://api.class-pie.com.au/api/1.0/u/connect/roleinfobyfundid?fundId=fffa6ce3-48b6-484b-aaf6-2a2ba5563646' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success (Ok)

Bodyapplication/json

ErrorsArray of objects

A list of errors returned by the API. An empty array indicates a successful response.

Dataobjectrequired

The primary data payload containing the user's role information for the specified fund.

Response

{
  "Data": {
    "PartyRoles": [
      "ADVISOR",
      "ADMIN",
      "TRUSTINDIVIDUAL"
    ],
    "MembershipRoles": []
  },
  "Errors": []
}