Get Organization Rosters

Gets the rosters in an organization.

Special Characters

There are special characters that can be used in a query string:

  • (+) represents the next field and must be URL-encoded.
  • (:) represents equals. An example is key : value.
  • Space characters must be URL-encoded.
  • Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).

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

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