Participant APIs | REST

Selected Version:
Download Open API File

Search employees

https://api.wealthcare.com/participant/services/participant/employee/{tpaId}

Search for employees based on specified criteria, including employer ID and various search parameters. This endpoint is useful for retrieving employee information from the system based on specific search conditions.

Security

Security page anchor

Path parameters

Path parameters page anchor
  • tpaId string Required

    A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

Query parameters

Query parameters page anchor
  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

Header parameters

Header parameters page anchor
  • Api-Version string

    The version of this operation to be used by this request. Note: Forgetting to include this header will result in the API using version 0.0.

    Value: 23.0

Request body

Request body page anchor
  • ExcludePIEmpr boolean

    Send true to exclude employees under an employer in a Permanently Inactive status. Send false to include employees under an employer in a Permanently Inactive status.

  • EmprId string

    Specify the unique Employer ID generated by WealthCare Admin if the employer is known, or use an empty string to search all employers

  • SearchBy enum<string>

    Used with the SearchFor value. Specifies what type of data is sent in SearchFor. I.e., if a 3 is sent here, then the value sent in SearchFor will be compared to LastName values of employees in the system to determine what employees will be returned.

    Possible values: EmployeeId FirstName LastName FirstLastName SSN CardNumber EmailAddress HealthId PBMId Address1 PhoneNumber PPAccountNumber AlternateId
  • SearchFor string

    Used with the SearchBy field. This is the value actually being searched for.

  • MaxRecords integer <int32>

    The maximum number of records to include in the response. Minimum value is 1; maximum value is 999,999.

  • StartOrdinal integer <int32>

    This can be used if searches are being completed in batches. Minimum value is 1; maximum value is 999,999. For example, if you want to only handle 25 results at a time, you would send 1 for this value on the first call (and 25 for MaxRecords), and if/when the next 25 are needed, send 26 for this value on the second call (and still send 25 for MaxRecords) in order to get results 26-50.

  • ExcludePIEmpr boolean

    Send true to exclude employees under an employer in a Permanently Inactive status. Send false to include employees under an employer in a Permanently Inactive status.

  • EmprId string

    Specify the unique Employer ID generated by WealthCare Admin if the employer is known, or use an empty string to search all employers

  • SearchBy enum<string>

    Used with the SearchFor value. Specifies what type of data is sent in SearchFor. I.e., if a 3 is sent here, then the value sent in SearchFor will be compared to LastName values of employees in the system to determine what employees will be returned.

    Possible values: EmployeeId FirstName LastName FirstLastName SSN CardNumber EmailAddress HealthId PBMId Address1 PhoneNumber PPAccountNumber AlternateId
  • SearchFor string

    Used with the SearchBy field. This is the value actually being searched for.

  • MaxRecords integer <int32>

    The maximum number of records to include in the response. Minimum value is 1; maximum value is 999,999.

  • StartOrdinal integer <int32>

    This can be used if searches are being completed in batches. Minimum value is 1; maximum value is 999,999. For example, if you want to only handle 25 results at a time, you would send 1 for this value on the first call (and 25 for MaxRecords), and if/when the next 25 are needed, send 26 for this value on the second call (and still send 25 for MaxRecords) in order to get results 26-50.

  • ExcludePIEmpr boolean

    Send true to exclude employees under an employer in a Permanently Inactive status. Send false to include employees under an employer in a Permanently Inactive status.

  • EmprId string

    Specify the unique Employer ID generated by WealthCare Admin if the employer is known, or use an empty string to search all employers

  • SearchBy enum<string>

    Used with the SearchFor value. Specifies what type of data is sent in SearchFor. I.e., if a 3 is sent here, then the value sent in SearchFor will be compared to LastName values of employees in the system to determine what employees will be returned.

    Possible values: EmployeeId FirstName LastName FirstLastName SSN CardNumber EmailAddress HealthId PBMId Address1 PhoneNumber PPAccountNumber AlternateId
  • SearchFor string

    Used with the SearchBy field. This is the value actually being searched for.

  • MaxRecords integer <int32>

    The maximum number of records to include in the response. Minimum value is 1; maximum value is 999,999.

  • StartOrdinal integer <int32>

    This can be used if searches are being completed in batches. Minimum value is 1; maximum value is 999,999. For example, if you want to only handle 25 results at a time, you would send 1 for this value on the first call (and 25 for MaxRecords), and if/when the next 25 are needed, send 26 for this value on the second call (and still send 25 for MaxRecords) in order to get results 26-50.

  • ExcludePIEmpr boolean

    Send true to exclude employees under an employer in a Permanently Inactive status. Send false to include employees under an employer in a Permanently Inactive status.

  • EmprId string

    Specify the unique Employer ID generated by WealthCare Admin if the employer is known, or use an empty string to search all employers

  • SearchBy enum<string>

    Used with the SearchFor value. Specifies what type of data is sent in SearchFor. I.e., if a 3 is sent here, then the value sent in SearchFor will be compared to LastName values of employees in the system to determine what employees will be returned.

    Possible values: EmployeeId FirstName LastName FirstLastName SSN CardNumber EmailAddress HealthId PBMId Address1 PhoneNumber PPAccountNumber AlternateId
  • SearchFor string

    Used with the SearchBy field. This is the value actually being searched for.

  • MaxRecords integer <int32>

    The maximum number of records to include in the response. Minimum value is 1; maximum value is 999,999.

  • StartOrdinal integer <int32>

    This can be used if searches are being completed in batches. Minimum value is 1; maximum value is 999,999. For example, if you want to only handle 25 results at a time, you would send 1 for this value on the first call (and 25 for MaxRecords), and if/when the next 25 are needed, send 26 for this value on the second call (and still send 25 for MaxRecords) in order to get results 26-50.

Response

Response body

Response body page anchor
  • array <object>
    • TpaId string

      A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

    • EmprId string

      Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

    • EmpeId string

      Employee ID; unique identifier for the employee.

    • FirstName string

      First Name of the Employee

    • LastName string

      Last Name of the Employee

    • MiddleInitial string

      Middle / Initial of the Employee

    • NamePrefix string

      Name Prefix of the Employee

  • array <object>
    • TpaId string

      A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

    • EmprId string

      Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

    • EmpeId string

      Employee ID; unique identifier for the employee.

    • FirstName string

      First Name of the Employee

    • LastName string

      Last Name of the Employee

    • MiddleInitial string

      Middle / Initial of the Employee

    • NamePrefix string

      Name Prefix of the Employee

  • array <object>
    • TpaId string

      A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

    • EmprId string

      Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

    • EmpeId string

      Employee ID; unique identifier for the employee.

    • FirstName string

      First Name of the Employee

    • LastName string

      Last Name of the Employee

    • MiddleInitial string

      Middle / Initial of the Employee

    • NamePrefix string

      Name Prefix of the Employee

  • array <object>
    • TpaId string

      A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

    • EmprId string

      Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

    • EmpeId string

      Employee ID; unique identifier for the employee.

    • FirstName string

      First Name of the Employee

    • LastName string

      Last Name of the Employee

    • MiddleInitial string

      Middle / Initial of the Employee

    • NamePrefix string

      Name Prefix of the Employee

The Try It feature is available in the beta Developer Portal. To use it, navigate to the beta version of this page.
Request

Copyright © 2026 Alegeus Technologies, LLC. All rights reserved. Alegeus, Alegeus Technologies, WealthCare, WealthCare Saver are registered trademarks of Alegeus Technologies, LLC

AI Assistant Preview

Generating response...