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.
get
/api/v2/tenants/{tenantId}/rosters/search

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Query Parameters

  • pageNointeger

    Default: 1

  • pageSizeinteger

    Default: 100

  • isDescendingOrderboolean

  • sortNamestring

    Default: id

  • queryStringstring

  • 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.

00