retrieveAll21

abstract suspend fun retrieveAll21(officeId: Long? = null, externalId: String? = null, displayName: String? = null, firstName: String? = null, lastName: String? = null, status: String? = null, underHierarchy: String? = null, offset: Int? = null, limit: Int? = null, orderBy: String? = null, sortOrder: String? = null, orphansOnly: Boolean? = null): GetClientsResponse

List Clients The list capability of clients can support pagination and sorting. Example Requests: clients clients?fields=displayName,officeName,timeline clients?offset=10&limit=50 clients?orderBy=displayName&sortOrder=DESC Responses:

  • 200: OK

Return

GetClientsResponse

Parameters

officeId

officeId (optional)

externalId

externalId (optional)

displayName

displayName (optional)

firstName

firstName (optional)

lastName

lastName (optional)

status

status (optional)

underHierarchy

underHierarchy (optional)

offset

offset (optional)

limit

limit (optional)

orderBy

orderBy (optional)

sortOrder

sortOrder (optional)

orphansOnly

orphansOnly (optional)