Search Rosters

Search rosters within a tenant.

Differentiate Rosters

To differentiate between partner-level and client-level rosters:

  • Client level roster: If client and client details are provided.
  • Partner-level roster: If allClients: true is provided.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Query Parameters

  • pageNointeger

    Current pagination number

  • pageSizeinteger

    No of records in each page

  • isDescendingOrderboolean

    Pagination data ordering: true for descending false for ascending

  • sortNamestring

    Field name on which paginated data is ordered

  • queryStringstringrequired

    Generic query string to be prepared using below query parameters See "api-overview"

  • namestring

    The roster name (must be identical to match)

  • allListboolean

    If true, get both partner and client level rosters and if false (the default), get partner level rosters.


  • resultsarray

  • totalResultsinteger

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • previousPageNointeger

  • descendingOrderboolean

Loading Examples...