Get a doucment audience.

https://api.wealthcare.com/participant/services/document/management/audience/{tpaId}/{audienceId}

Retrieve detailed information about a specific document audience identified by the TPA ID and audience ID. This operation is useful for understanding the members and options associated with a particular audience in the document management system.

Request

Path parameters

tpaId string Required

A unique identifier used to identify your admin instance. This value is system generated when the admin instance was created.
audienceId string Required

Document audience Id

Query parameters

decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. Use 1 for encrypted, 0 for decrypted (default is 0). This affects how the API interprets the incoming identifiers.

Response

Response body

TpaId string
AudienceKey integer <int32>
AudienceId string
AudienceName string
AudienceMembers object
- TpaId string
- Employers array <object>
  - TpaId string
  - EmprId string
  - EmprName string
- Divisions array <object>
  - TpaId string
  - EmprId string
  - EmprName string
  - DivisionKey integer <int32>
  - DivisionName string
- Subgroups array <object>
  - TpaId string
  - EmprId string
  - EmprName string
  - SubGroupKey integer <int32>
  - SubgroupName string
- AcctTypes array <object>
  - TpaId string
  - AcctTypeCde string
  - AcctTypeDesc string
  - AcctTypeClass enum<string>
    
    Possible values: FSA HRA HSA Deductible Other VEBA Transit Parking Retiree
  - AcctTypeClassDesc string
- HideSubgroup boolean
AudienceOptions enum<string>

Possible values: None AllEmployer AllDivision AllSubgroup AllAcctType EmptyEmployer EmptyDivision EmptySubgroup EmptyAcctType
LastUpdateDate string <date-time>

TpaId string
AudienceKey integer <int32>
AudienceId string
AudienceName string
AudienceMembers object
- TpaId string
- Employers array <object>
  - TpaId string
  - EmprId string
  - EmprName string
- Divisions array <object>
  - TpaId string
  - EmprId string
  - EmprName string
  - DivisionKey integer <int32>
  - DivisionName string
- Subgroups array <object>
  - TpaId string
  - EmprId string
  - EmprName string
  - SubGroupKey integer <int32>
  - SubgroupName string
- AcctTypes array <object>
  - TpaId string
  - AcctTypeCde string
  - AcctTypeDesc string
  - AcctTypeClass enum<string>
    
    Possible values: FSA HRA HSA Deductible Other VEBA Transit Parking Retiree
  - AcctTypeClassDesc string
- HideSubgroup boolean
AudienceOptions enum<string>

Possible values: None AllEmployer AllDivision AllSubgroup AllAcctType EmptyEmployer EmptyDivision EmptySubgroup EmptyAcctType
LastUpdateDate string <date-time>

Request URL

Authorization Bearer Token

tpaId (Required)

audienceId (Required)

decrypt

No response yet.

No response yet.

Participant APIs | REST