surveys

Example Query

query ExampleQuery($queryOffset: Int, $queryLimit: Int, $activeState: ActiveState, $ids: [UUID], $countOnly: Boolean, $freeTextSearch: String, $filterOperator: LogicalOperator, $filters: [FilterConditionInput], $locationId: [String], $assignedTo: [String], $performedBy: [String], $name: [String], $surveyType: [SurveyType], $status: [SurveyStatus], $templateId: [String], $companyId: [String], $fromDate: DateTime, $toDate: DateTime, $filterByDateCreated: Boolean) {
  surveys(queryOffset: $queryOffset, queryLimit: $queryLimit, activeState: $activeState, ids: $ids, countOnly: $countOnly, freeTextSearch: $freeTextSearch, filterOperator: $filterOperator, filters: $filters, locationId: $locationId, assignedTo: $assignedTo, performedBy: $performedBy, name: $name, surveyType: $surveyType, status: $status, templateId: $templateId, companyId: $companyId, fromDate: $fromDate, toDate: $toDate, filterByDateCreated: $filterByDateCreated) {
    documents {
      id
      documentType
      activeState
      created
      changed
      createdBy
      changedBy
      tenantId
      companyId
      locationId
    }
    count
  }
}

Variables

{
  "queryOffset": 0,
  "queryLimit": 0,
  "activeState": "ACTIVE",
  "ids": [
    "example"
  ],
  "countOnly": true,
  "freeTextSearch": "example",
  "filterOperator": "AND",
  "filters": [
    {
      "column": "example",
      "operator": "EQ",
      "value": "example",
      "jsonPath": "example"
    }
  ],
  "locationId": [
    "example"
  ],
  "assignedTo": [
    "example"
  ],
  "performedBy": [
    "example"
  ],
  "name": [
    "example"
  ],
  "surveyType": [
    "TEMPLATE"
  ],
  "status": [
    "CREATED"
  ],
  "templateId": [
    "example"
  ],
  "companyId": [
    "example"
  ],
  "fromDate": "2026-09-18T23:05:42.669Z",
  "toDate": "2026-09-18T23:05:42.669Z",
  "filterByDateCreated": true
}

Example response

{
  "data": {
    "surveys": {
      "documents": [
        {
          "id": "example",
          "documentType": "ANALYTICS",
          "activeState": "ACTIVE",
          "created": "2026-09-18T23:05:42.669Z",
          "changed": "2026-09-18T23:05:42.669Z",
          "createdBy": "example",
          "changedBy": "example",
          "tenantId": "example",
          "companyId": "example",
          "locationId": "example"
        }
      ],
      "count": 0
    }
  }
}

Arguments

queryOffsetIntegerOptional

Limit search with start index.

queryLimitIntegerOptional

Limit search with stop index.

activeStateActiveStateOptional

Active state

Allowed values:

idslist of optional StringsOptional

Document ids.

countOnlyBooleanOptional

Return only count.

freeTextSearchStringOptional

Free text search.

filterOperatorLogicalOperatorOptional

Filter operator, e.g. 'and', 'or'.

Allowed values:

filterslist of optional FilterConditionInputOptional

List of filters to apply on the query.

locationIdlist of optional StringsOptional

Location ids.

assignedTolist of optional StringsOptional

Assigned to.

performedBylist of optional StringsOptional

Assigned to.

namelist of optional StringsOptional

Survey name

surveyTypelist of optional SurveyTypeOptional

Survey type.

Allowed values:

statuslist of optional SurveyStatusOptional

Status.

Allowed values:

templateIdlist of optional StringsOptional

Survey template ids

companyIdlist of optional StringsOptional

Company ids

fromDateDatetimeOptional

From date submission of survey.

toDateDatetimeOptional

To date submission of survey.

filterByDateCreatedBooleanOptional

Filter by date created.

Returns

an optional SurveyQuery

documentslist of optional SurveyOptional

countIntegerOptional

Query result count.