Members

Returns a list of the members within the fund

get/sites/{site-identifier}/funds/{fund-identifier}/members

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/funds/{fund-identifier}/members
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: default, fund_read, fund:members_read)

Path parameters

site-identifierstring required

The GUID that identifies a site

fund-identifierstring required

The GUID that identifies a fund

Query parameters

nameFormatstring
Example:GS or 1GS or S,1G or TGS or T1GS or S,G
includeAgeboolean
Example:true

Response

Success

MemberGUIDstring guid
MemberNamestring
Status'Active' | 'Terminated'
StatusDetail'' | 'ACTIVE' | 'DECEASED' | 'RETIRED'
SpouseMemberGUIDstring guid
BirthDatestring date

Example response

[
  {
    "Accounts": [
      {
        "HasWithdrawalNotes": true,
        "Segregated": true
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.