Skip to content

Developers · GraphQL

GraphQL Data Queries

Last updated 5 November 2026

Use this document as a reference for Common GraphQL Data Queries.

constants

Code example:

constants(
  filter: EncryptedConstantsFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [EncryptedConstantsSortInput!]
): EncryptedConstantCollection!

Arguments

Type

current_user

Code example:

current_user: User

Type

documents

Code example:

documents(
  aggregations: [ListingAggregation]
  filter: [IndexSearchFilterInput!]
  page: Int = 1
  per_page: Int!
  query: IndexSearchQuery
  search_index: String!
  sort: [IndexSearchSortInput!]
): IndexSearchCollection!

Arguments

Fulltext search.

Index name.

Type

records

Returns a collection of all records in the system.

records(
  filter: RecordsFilterInput
  page: Int = 1
  per_page: Int!
  sort: [RecordsSortInput!]
): RecordCollection!

Arguments

Type

remote_records

Returns a collection of remote records.

remote_records(
  endpoint: Endpoint!
  filter: RecordsFilterInput
  page: Int = 1
  per_page: Int!
  sort: [RecordsSortInput!]
): RecordCollection!

Arguments

An endpoint that returns resources for the given IDs in JSON format.

Type

remote_users

Code example:

remote_users(
  endpoint: Endpoint!
  filter: UsersFilterInput
  page: Int = 1
  per_page: Int!
  sort: [UsersSortInput!]
): UserCollection!

Arguments

An endpoint returns resources for the given IDs in JSON format.

Type

users

Code example:

users(
  filter: UsersFilterInput
  page: Int = 1
  per_page: Int!
  sort: [UsersSortInput!]
): UserCollection!

Arguments

Type

Reference

You may visit the following resources for more information:

  • EncryptedConstantCollection
  • EncryptedConstantsFilterInput
  • EncryptedConstantsSortInput
  • Endpoint
  • IndexSearchCollection
  • IndexSearchFilterInput
  • IndexSearchSortInput
  • Int
  • ListingAggregation
  • Query
  • RecordCollection
  • RecordsFilterInput
  • RecordsSortInput
  • String
  • User
  • UserCollection
  • UsersFilterInput
  • UsersSortInput