Get Member Consent

get

https://s3partnerapi-staging.solutran.com/2.2/consent/{clientid}

Retrieves member consent records based on the provided filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientid

string

required

The account identifier.

Query Params

HouseholdId

int64

The S3 internal household identifier. Required if Id-Type header is not 'Client'.

ClientAccountId

string

The client-specific account identifier. Required if Id-Type header is 'Client'.

ProgramId

int32

required

1 to 2147483647

The S3 program the account belongs to.

Level

string

Consent level. Required. Consent level - PAYER, PROGRAM, GROUP, SUBGROUP.

LevelId

string

The identifier for the specified level.

ConsentType

string

The type of consent to filter by (e.g., DATA_SHARE, SMS_ALERTS, EMAIL_MARKETING, SEE_BALANCE, etc. Required. ).

Status

string

Consent Status to filter by (e.g., 'OPTED_IN', 'OPTED_OUT', 'EXPIRED'). If not provided, all consent statuses will be returned.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error