AM Logo
API AuthorizationAPI DocumentationForm DefinitionsFAQ
  1. Home
  3. API Documentation
  5. Outcomes
  7. Queries
  9. clients

clients: PagingResultOfClient!

This query returns list of clients and their details based on search criteria. The returned list is limited based on the permissions of the customers API Token. The information returned for each client can include demographics, contact information, information related to cases and tools. **Returns:** Returns an array of client information.

  3. filterBy

id: PropertyFilterOfGuidInput

publicId: PropertyFilterOfStringInput

tenantId: PropertyFilterOfGuidInput

userId: PropertyFilterOfGuidInput

isDeleted: PropertyFilterOfBooleanInput

isActive: PropertyFilterOfBooleanInput

firstName: PropertyFilterOfStringInput

middleName: PropertyFilterOfStringInput

lastName: PropertyFilterOfStringInput

timeZone: PropertyFilterOfTimeZoneInfoInput

culture: PropertyFilterOfCultureInfoInput

addresses: ClientAddressFilterInput

emailAddresses: ClientEmailAddressFilterInput

phoneNumbers: ClientPhoneNumberFilterInput

demographics: DemographicsFilterInput

insurance: InsuranceFilterInput

fullName: PropertyFilterOfStringInput

lastActivityDate: PropertyFilterOfNullableOfDateTimeOffsetInput

cases: CaseFilterInput

externalIdentifiers: ClientExternalIdentifierFilterInput

caseAspectOwnership: PropertyFilterOfCaseAspectOwnershipFilterValueInput

communication: CommunicationFilterInput

externalIdentifier: PropertyFilterOfClientExternalIdentifierFilterValueInput

clientActivity: PropertyFilterOfClientActivityFilterInput

assignedOrganizationalUnits: PropertyFilterOfClientOrganizationalUnitAssignationFilterInput

username: PropertyFilterOfStringInput

or: [ClientFilterInput!]

and: [ClientFilterInput!]