Search Account

get

https://s3partnerapi-staging.solutran.com/2.2/accounts

Search accounts by various criteria.
Use this endpoint to look up a specific account using your clientAccountId, or to retrieve
a collection of accounts matching specific criteria (e.g. all active accounts in the "Math Teachers" subgroup).

Lookup by clientAccountId:
curl -H "Authorization: Bearer {TOKEN}" /accounts?clientAccountId=ACT1001

Query all active accounts:
curl -H "Authorization: Bearer {TOKEN}" /accounts?status=active

Note: Default limit is 50 results per response. Always check meta.moreExists to determine whether additional pages are available.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

int64

The unique account identifier.

Status

string

The account status filter. e.g. active

ClientAccountId

string

The client-specific account identifier.

SubgroupId

string

The subgroup identifier for the account.

UserDefined1

string

length ≤ 50

The first user-defined field. Maximum 50 characters.

UserDefined2

string

length ≤ 50

The second user-defined field. Maximum 50 characters.

UserDefined3

string

length ≤ 50

The third user-defined field. Maximum 50 characters.

UserDefined4

string

length ≤ 50

The fourth user-defined field. Maximum 50 characters.

AlternateSearchKey

string

length ≤ 50

The alternate search key for the account. Maximum 50 characters.

MembershipAlternateSearchKey

string

length ≤ 100

The membership alternate search key. Maximum 100 characters.

HealthySavingsEligible

string

The healthy savings eligibility status. Must be "Y" or "N".

CardNumber

string

The card number associated with the account.

ClientGroupId

string

The client group identifier.

ProgramId

string

The program identifier.

FirstName

string

The account holder's first name.

LastName

string

The account holder's last name.

DateOfBirth

date-time

The account holder's date of birth.

City

string

The account holder's city.

StateCode

string

The account holder's state code. Must be a valid US state code.

PostalCode

string

The account holder's postal code.

IncludeInternalBenefits

boolean

Indicates whether internal benefits should be included in the search results.

SearchCriteria

string

Generates a query string representation of the search criteria.
Only includes parameters that have non-null, non-empty values.

DefaultSort

string

The default sorting criteria for account searches.

PartnerId

string

Optional partner identifier for the request context.

Include

string

A comma-separated list of related resources to include in the response. Not used for balance inquiry endpoint.

Allowed values for this resource: benefits, benefits.promotions, transactions, cards, memberships, member. Multiple values can be comma-separated.

Path

string

The API endpoint path for the current request.
Used internally for request tracking and logging purposes.

TotalCount

int32

The total number of records available for the search criteria.
May be hidden from serialization based on HideTotals setting.

Size

int32

The actual number of records returned in the current response.

Offset

int32

The starting position (zero-based) for the current page of results.

Limit

int32

The maximum number of records to return per page.
Default value is 100 records.

Sort

string

The sorting criteria for the current request.
Used internally for query processing and not included in JSON serialization.

MoreExist

boolean

Indicates whether more results exist beyond the current page.
Automatically calculated based on TotalCount, Limit, and Offset unless explicitly overridden.

HideTotals

boolean

Controls whether total count information should be hidden from the response.
Used internally for performance optimization when total counts are expensive to calculate.

SummaryData

string

Additional summary data that can be included with the response.
Used for aggregated information or custom metadata specific to the search results.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

204

No Content

200OK

400Bad Request

401Unauthorized

403Forbidden

422Unprocessable Content