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
  5. cases

id: PropertyFilterOfGuidInput

publicId: PropertyFilterOfStringInput

dateCreated: PropertyFilterOfDateTimeOffsetInput

workflowId: PropertyFilterOfGuidInput

tenantId: PropertyFilterOfGuidInput

clientId: PropertyFilterOfGuidInput

organizationalUnitId: PropertyFilterOfGuidInput

enrollmentDate: PropertyFilterOfDateTimeOffsetInput

dischargeDate: PropertyFilterOfDateTimeOffsetInput

dependantUserQuery: PropertyFilterOfStringInput

isClosed: PropertyFilterOfBooleanInput

dateClosed: PropertyFilterOfNullableOfDateTimeOffsetInput

expectedClearanceDate: PropertyFilterOfNullableOfDateTimeOffsetInput

startingPointId: PropertyFilterOfNullableOfGuidInput

isDeleted: PropertyFilterOfBooleanInput

status: PropertyFilterOfCaseStatusFilterValueInput

metadata: MetadataEntryFilterInputOfCaseMetadataEntryAndCasesManagementEntityFilterContextInput

metadataKeyValue: PropertyFilterOfMetadataFilterValueOfCaseMetadataEntryInput

aspectOwnerId: PropertyFilterOfGuidInput

aspectOwnerUserQuery: PropertyFilterOfStringInput

aspectOwnership: PropertyFilterOfCaseAspectFilterValueInput

hasStartingPoint: PropertyFilterOfBooleanInput

client: ClientFilterInput

organizationalUnit: OrganizationalUnitFilterInput

workflow: WorkflowFilterInput

formSubmissions: CaseFormSubmissionFilterInput

formSubmissionRequests: CaseFormSubmissionRequestFilterInput

notes: CaseNoteFilterInput

documents: CaseDocumentFilterInput

aspects: CaseAspectFilterInput

or: [CaseFilterInput!]

and: [CaseFilterInput!]