Homepage
Search icon

RootQuery

Last edit: Oct 13, 2026

Entry point for all read operations. Fields are grouped into documentation categories with the @doc directive

type RootQuery {
  activities(
    ids: [ID]
    page: Int = 1
    per_page: Int = 20
    sort: [ActivitiesSortInput!]
    uuids: [String]
  ): ActivityStreamsActivityCollection
  admin_api_call_notifications(
    filter: ApiCallNotificationsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [ApiCallNotificationsSortInput!]
  ): ApiCallNotificationCollection!
  admin_assets(
    filter: QueryAssetsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [AssetsSortInput!]
  ): AssetCollection!
  admin_assets_listing(id: ID!): AssetsListing!
  admin_authorization_policies(
    filter: AuthorizationPoliciesFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [AuthorizationPoliciesSortInput!]
  ): AuthorizationPolicyCollection!
  admin_background_jobs(
    filter: BackgroundJobsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [BackgroundJobsSortInput!]
  ): BackgroundJobCollection!
  admin_current_instance: Instance!
  admin_email_notifications(
    filter: EmailNotificationsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [EmailNotificationsSortInput!]
  ): EmailNotificationCollection!
  admin_form_configurations(
    filter: FormConfigurationsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [FormConfigurationsSortInput!]
  ): FormConfigurationCollection!
  admin_forms(
    filter: FormsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [FormsSortInput!]
  ): FormCollection!
  admin_graphql(
    filter: GraphqlFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [GraphqlSortInput!]
  ): GraphQueryCollection!
  admin_instance_metrics: InstanceMetrics!
  admin_liquid_layouts(
    filter: LiquidLayoutsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [LiquidLayoutsSortInput!]
  ): LiquidLayoutCollection!
  admin_liquid_partials(
    filter: LiquidPartialsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [LiquidPartialsSortInput!]
  ): LiquidPartialCollection!
  admin_logs(filter: LogsFilterInput, per_page: Int): [AdminLogEntry!]!
  admin_model_schemas(
    filter: ModelSchemasFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [ModelSchemasSortInput!]
  ): ModelSchemaCollection!
  admin_pages(
    exclude: Boolean
    filter: PageFilterInput
    has_key: String
    metadata: String
    name: String
    page: Int = 1
    per_page: Int = 20
    sort: [PagesSortInput!]
    value: String
  ): PageCollection!
  admin_search_index(search_index: String!): HashObject
  admin_search_index_rc(search_index: String!): HashObject
  admin_sent_notifications(
    filter: SentNotificationsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [SentNotificationsSortInput!]
  ): SentNotificationCollection!
  admin_sms_notifications(
    filter: SmsNotificationsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [SmsNotificationsSortInput!]
  ): SmsNotificationCollection!
  admin_tables(
    filter: TablesFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [TablesSortInput!]
  ): TableCollection!
  admin_third_party_integrations(
    filter: ThirdPartyIntegrationsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [ThirdPartyIntegrationsSortInput!]
  ): ThirdPartyIntegrationCollection!
  admin_transactable_schemas(
    filter: TransactableSchemasFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [TransactableSchemasSortInput!]
  ): TransactableSchemaCollection!
  admin_user_profile_schemas(
    filter: UserProfileSchemasFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [UserProfileSchemasSortInput!]
  ): UserProfileSchemaCollection!
  admin_user_schema: UserSchema!
  admin_versions(
    filter: VersionFilterInput
    options: QueryOptionsInput
    page: Int = 1
    per_page: Int = 20
    sort: [VersionSortInput!]
  ): VersionCollection!
  cms_discovery(types: [CMSItemType]): CMSItemDefinitionCollection
  cms_items(
    page: Int = 1
    per_page: Int
    type: CMSItemType!
  ): CMSItemPayloadCollection
  constant(filter: EncryptedConstantFilterInput): EncryptedConstant
  constants(
    filter: EncryptedConstantsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [EncryptedConstantsSortInput!]
  ): EncryptedConstantCollection!
  current_user: User
  custom_attribute_definition(name: String!): CustomAttributeDefinition
  customization(id: ID, name: String): Customization
  customizations(
    aggregations: [ListingAggregation]
    created_at: DateRange
    custom_model_type: QueryCustomModelType
    customizable_id: ID
    customizable_ids: [ID]
    customizable_type: String
    external_id: ID
    external_ids: [ID]
    id: ID
    ids: [ID]
    is_deleted: Boolean
    model_schema: QueryModelSchema
    name: String
    names: [String]
    page: Int = 1
    per_page: Int = 20
    properties: [QueryCustomAttribute]
    query: Query
    sort: [SortOrder]
    updated_at: DateRange
    user_id: ID
    user_ids: [ID]
    without_ids: [ID]
    without_names: [String]
  ): ListingsCustomizationCollection!
  data_exports(
    filter: DataExportsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [DataExportsSortInput!]
  ): DataExportCollection!
  documents(
    aggregations: [ListingAggregation]
    filter: [IndexSearchFilterInput!]
    page: Int = 1
    per_page: Int!
    query: IndexSearchQuery
    search_index: String!
    sort: [IndexSearchSortInput!]
  ): IndexSearchCollection!
  documents_rc(
    aggregations: [ListingAggregation]
    filter: [IndexSearchFilterInput!]
    page: Int = 1
    per_page: Int!
    query: IndexSearchQuery
    search_index: String!
    sort: [IndexSearchSortInput!]
  ): IndexSearchCollection!
  embeddings(
    filter: EmbeddingsFilterInput
    options: QueryOptionsInput
    page: Int = 1
    per_page: Int!
    sort: [EmbeddingsSortInput!]
  ): EmbeddingCollection!
  embeddings_rc(
    filter: EmbeddingsFilterInput
    options: QueryOptionsInput
    page: Int = 1
    per_page: Int!
    sort: [EmbeddingsSortInput!]
  ): EmbeddingCollection!
  feeds: [ActivityStreamsFeed]
  handlers(page: Int = 1, per_page: Int = 20): ActivityStreamsHandlerCollection
  images(
    filter: ImagesFilterInput
    page: Int = 1
    per_page: Int!
    sort: [ImagesSortInput!]
  ): CustomImageCollection!
  instance: Instance
  listings(
    aggregations: [ListingAggregation]
    geo_query: GeoQuery
    listing: QueryListing
    page: Int = 1
    per_page: Int = 20
    query: Query
    sort: [SortOrder]
  ): ListingCollection!
  login_providers: [String]
  model(id: ID, name: String): Customization
  models(
    filter: ModelsFilterInput
    options: QueryOptionsInput
    page: Int = 1
    per_page: Int!
    sort: [ModelsSortInput!]
  ): ModelCollection!
  pages(
    exclude: Boolean
    filter: PageFilterInput
    has_key: String
    metadata: String
    name: String
    page: Int = 1
    per_page: Int = 20
    sort: [PagesSortInput!]
    value: String
  ): PageCollection!
  people(
    aggregations: [ListingAggregation]
    geo_query: GeoQuery
    page: Int = 1
    per_page: Int = 20
    query: Query
    sort: [SortOrder]
    user: QueryUser
  ): UserListingCollection!
  records(
    filter: RecordsFilterInput
    options: QueryOptionsInput
    page: Int = 1
    per_page: Int!
    sort: [RecordsSortInput!]
  ): RecordCollection!
  remote_records(
    endpoint: Endpoint!
    filter: RecordsFilterInput
    page: Int = 1
    per_page: Int!
    sort: [RecordsSortInput!]
  ): RecordCollection!
  remote_users(
    endpoint: Endpoint!
    filter: UsersFilterInput
    page: Int = 1
    per_page: Int!
    sort: [UsersSortInput!]
  ): UserCollection!
  request: HTTPRequestContext
  streams(
    feed_id: ID
    feed_name: String
    feed_type: String!
    page: Int = 1
    per_page: Int = 20
    reset_last_read: Boolean = true
  ): ActivityStreamsActivityStreamCollection
  transactable(creator_id: ID, id: ID, slug: String): Transactable!
  transactable_type(id: ID, name: String): TransactableType
  transactable_types(ids: [ID], names: [String]): [TransactableType]
  transactables(page: Int = 1, per_page: Int = 20): TransactableCollection!
  user(
    email: String
    external_id: String
    id: ID
    is_deleted: Boolean
    options: QueryOptionsInput
    slug: String
  ): User
  users(
    filter: UsersFilterInput
    options: QueryOptionsInput
    page: Int = 1
    per_page: Int!
    sort: [UsersSortInput!]
  ): UserCollection!
}

Fields

activities (ActivityStreamsActivityCollection)

Returns activities published to activity feeds, looked up by id or uuid

  • ids (ID)

Returns only activities with one of these ids

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied
in the given order. Results are additionally sorted by id ascending unless
id (or random) is part of the sort

Returns only activities with one of these uuids, in the order the uuids are given

admin_api_call_notifications (ApiCallNotificationCollection)

Returns API call notifications (app/api_calls) of the instance, sorted by name
unless sort is given. Files from the private directories of modules are not included.

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_assets (AssetCollection)

Returns assets (app/assets) of the instance, sorted by name unless sort is
given. Soft deleted assets are included only when filtering by deleted_at.
Assets from the private directories of modules are not included.

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_assets_listing (AssetsListing)

Returns an asset listing generated in the background by the
admin_assets_listing_create mutation: its status and, once done, the URLs of
the manifests of public and private assets.

ID returned by the admin_assets_listing_create mutation

admin_authorization_policies (AuthorizationPolicyCollection)

Returns authorization policies (app/authorization_policies) of the instance,
sorted by name unless sort is given. Files from the private directories of
modules are not included.

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_background_jobs (BackgroundJobCollection)

Returns background jobs of the instance that are scheduled (default), waiting
for a retry, dead or running, depending on filter.type. Without sort,
scheduled, retry and dead jobs are listed by timestamp. Only the first 50
pages of up to 100 jobs each can be retrieved.

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one
returns an empty results list. Maximum 50, higher values are treated as 50

  • per_page (Int)

Number of results per page, must be greater than 0. Maximum 100, higher values are treated as 100

Sort order of the results. Fields are applied one after another, so the last one given determines the order

admin_current_instance (Instance)

Returns the instance serving the request: its id, name, timestamps and feature flags

admin_email_notifications (EmailNotificationCollection)

Returns email notifications (app/emails) of the instance, sorted by name
unless sort is given. Files from the private directories of modules are not included.

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_form_configurations (FormConfigurationCollection)

Returns forms of the instance. Deprecated, use admin_forms instead

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_forms (FormCollection)

Returns forms (app/forms) of the instance. Deprecated, use pages with GraphQL mutations instead

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_graphql (GraphQueryCollection)

Returns GraphQL queries and mutations stored in the instance (app/graphql),
sorted by name unless sort is given. Files from the private directories of
modules are not included.

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_instance_metrics (InstanceMetrics)

Returns the current number of records, users, user profiles, images,
attachments, addresses, activities and transactables stored in the instance.
Soft deleted items are not counted

admin_liquid_layouts (LiquidLayoutCollection)

Returns Liquid layouts (app/views/layouts) of the instance, sorted by path
unless sort is given. Files from the private directories of modules are not included.

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_liquid_partials (LiquidPartialCollection)

Returns Liquid partials (app/views/partials and app/lib) of the instance,
sorted by path unless sort is given. Files from the private directories of
modules are not included.

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_logs (AdminLogEntry)

Returns entries of the instance log (what pos-cli logs streams), oldest first.
Without a lower id bound it returns the latest matching entries; with filter:
{ id: { range: { gt: <id of the last entry seen> } } } only entries newer than
that one. Conditions on type or message are checked against the most recent
part of the log only.

Conditions the returned results must match. All conditions are combined with AND

  • per_page (Int)

Maximum number of entries to return, between 1 and 500. Defaults to 20, or to 500 with a lower id bound

admin_model_schemas (ModelSchemaCollection)

Returns model schemas, the former name of tables. Deprecated, use admin_tables instead

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_pages (PageCollection)

Returns pages (app/views/pages) of the instance, newest first unless sort is
given. Soft deleted pages are included only when filtering by deleted_at.
Files from the private directories of modules are not included.

Deprecated, negates the metadata, has_key and value conditions. Use filter: { metadata: { exclude: $exclude } }

Conditions the returned results must match. All conditions are combined with AND

Deprecated, use filter: { metadata: { has_key: $key } }

Deprecated, use filter: { metadata: { contains: $text } }

Deprecated, metadata key used together with value. Use filter: { metadata: {
attribute: { key: $name, value: $value } } }

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

Deprecated, use filter: { metadata: { attribute: { key: $key, value: $value } } }. Requires name

admin_search_index (HashObject)

Returns the field mapping of the search index of the instance, as configured with search_indexes in app/config.yml

Name of the search index. Currently not used: the mapping of the configured index is returned

admin_search_index_rc (HashObject)

Deprecated alias of admin_search_index

Name of the search index. Currently not used: the mapping of the configured index is returned

admin_sent_notifications (SentNotificationCollection)

Returns the log of notifications (emails, SMS, API calls) sent by the instance

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_sms_notifications (SmsNotificationCollection)

Returns SMS notifications (app/smses) of the instance, sorted by name unless
sort is given. Files from the private directories of modules are not included.

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_tables (TableCollection)

Returns table definitions (app/schema) of the instance, sorted by name unless
sort is given. Files from the private directories of modules are not included.

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_third_party_integrations (ThirdPartyIntegrationCollection)

Returns third party integrations configured for the instance, sorted by type unless sort is given

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_transactable_schemas (TransactableSchemaCollection)

Returns legacy transactable schemas. Deprecated, use admin_tables instead

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_user_profile_schemas (UserProfileSchemaCollection)

Returns legacy user profile schemas. Deprecated, use admin_tables instead

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

admin_user_schema (UserSchema)

Returns the user schema of the instance: the properties defined for users in app/user.yml

admin_versions (VersionCollection)

Returns the change history of records, users and user profiles from the last 7
days, newest first unless sort is given. Each version holds the state of the
object before the change.

Conditions the returned results must match. All conditions are combined with AND

Per-query execution options, such as reading from the read replica or a custom database timeout

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

cms_discovery (CMSItemDefinitionCollection)

Returns definitions of the CMS item types of the instance. Deprecated, use the admin_* queries instead

CMS item types to return; all when omitted

cms_items (CMSItemPayloadCollection)

Returns CMS items of the given type. Deprecated, use the admin_* queries instead

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Type of CMS items to return

constant (EncryptedConstant)

Returns a single constant with its decrypted value. Deprecated, use constants instead

Conditions the constant must match

constants (EncryptedConstantCollection)

Returns constants of the instance (set with constant_set or pos-cli constants)
with their decrypted values, sorted by name unless sort is given

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

current_user (User)

Returns the user signed in for the current request, or null when nobody is signed in

custom_attribute_definition (CustomAttributeDefinition)

Returns the definition of a property by name. Deprecated, use the admin_* queries instead

Name of the property

customization (Customization)

Returns a single record. Deprecated, use records instead

Unique identifier of the object

Name of the table the record belongs to

customizations (ListingsCustomizationCollection)

Searches records in the search index. Deprecated, use records instead

Aggregations to calculate over the matching records

Range of creation time

Deprecated, use model_schema

  • customizable_id (ID)

Id of the object the records belong to

  • customizable_ids (ID)

Ids of the objects the records belong to

Type of the object the records belong to

  • external_id (ID)

Returns only the record with this external id

  • external_ids (ID)

Returns only records with one of these external ids

Returns only the record with this id

  • ids (ID)

Returns only records with one of these ids

When true, returns only soft deleted records

Conditions on the table of the records

Name of the table

Names of the tables

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Conditions on record properties

Full-text search query

Sort order of the results. When several entries are given, they are applied in the given order

Range of last update time

  • user_id (ID)

Returns only records owned by this user

  • user_ids (ID)

Returns only records owned by one of these users

  • without_ids (ID)

Ids of records to exclude from results

Names of the tables whose records are excluded from results

data_exports (DataExportCollection)

Returns data exports of the instance (created with the data_export mutation or
pos-cli data export), most recently updated first. Once an export is done it
holds the URL of the exported file.

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Additional sort order, applied after the default most recently updated first

documents (IndexSearchCollection)

Searches documents in the custom search index of the instance (configured with
search_indexes in app/config.yml and filled with documents_insert,
documents_upsert and documents_bulk_upsert) by full-text query, filters and aggregations.

Aggregations (e.g. counts of documents per field value) to calculate over the matching documents

Conditions on document fields. All conditions are combined with AND

Page number to return, starting at 1. page multiplied by per_page cannot
exceed the result window of the search index; within it, a page beyond the
last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Full-text search query

Name of the search index the documents were inserted with

Sort order of the results. When several entries are given, they are applied in the given order

documents_rc (IndexSearchCollection)

Deprecated alias of documents

Aggregations (e.g. counts of documents per field value) to calculate over the matching documents

Conditions on document fields. All conditions are combined with AND

Page number to return, starting at 1. page multiplied by per_page cannot
exceed the result window of the search index; within it, a page beyond the
last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Full-text search query

Name of the search index the documents were inserted with

Sort order of the results. When several entries are given, they are applied in the given order

embeddings (EmbeddingCollection)

Returns embeddings (vectors with their content and metadata) stored in the
instance. Sort by embedding distance to find the entries nearest to a given vector.

Conditions the returned results must match. All conditions are combined with AND

Per-query execution options, such as reading from the read replica or a custom database timeout

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. Only sorting by embedding distance is applied

embeddings_rc (EmbeddingCollection)

Deprecated alias of embeddings

Conditions the returned results must match. All conditions are combined with AND

Per-query execution options, such as reading from the read replica or a custom database timeout

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. Only sorting by embedding distance is applied

feeds (ActivityStreamsFeed)

Returns all activity feeds of the instance: each feed type with the ids of its feeds

handlers (ActivityStreamsHandlerCollection)

Returns activity handlers (app/activity_streams/handlers), which decide to which feeds a published activity is added

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

images (CustomImageCollection)

Returns legacy image uploads. Deprecated, use upload properties instead

Conditions the returned results must match. All conditions are combined with AND

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied
in the given order. Results are additionally sorted by id ascending unless
id (or random) is part of the sort

instance (Instance)

Returns the current instance. Deprecated, use admin_current_instance instead

listings (ListingCollection)

Searches legacy transactables in the search index. Deprecated, use records instead

Aggregations to calculate over the matching transactables

Geo search query. Deprecated

Conditions on the transactables

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Full-text search query

Sort order of the results. When several entries are given, they are applied in the given order

login_providers (String)

Returns the names of configured social login providers. Deprecated

model (Customization)

Returns a single record. Deprecated, use records instead

Unique identifier of the object

Name of the table the record belongs to

models (ModelCollection)

Returns records under their former name, models. Soft deleted ones are
included only when filtering by deleted_at. Deprecated, use records instead

Conditions the returned results must match. All conditions are combined with AND

Per-query execution options, such as reading from the read replica or a custom database timeout

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied
in the given order. Results are additionally sorted by id ascending unless
id (or random) is part of the sort

pages (PageCollection)

Returns pages of the instance. Deprecated, use admin_pages instead

Deprecated, negates the metadata, has_key and value conditions. Use filter: { metadata: { exclude: $exclude } }

Conditions the returned results must match. All conditions are combined with AND

Deprecated, use filter: { metadata: { has_key: $key } }

Deprecated, use filter: { metadata: { contains: $text } }

Deprecated, metadata key used together with value. Use filter: { metadata: {
attribute: { key: $name, value: $value } } }

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied in the given order

Deprecated, use filter: { metadata: { attribute: { key: $key, value: $value } } }. Requires name

people (UserListingCollection)

Searches users in the search index. Deprecated, use users instead

Aggregations to calculate over the matching users

Geo search query

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Full-text search query

Sort order of the results. When several entries are given, they are applied in the given order

Conditions on the users

records (RecordCollection)

Returns records stored in tables of the instance. Soft deleted records are included only when filtering by deleted_at.

Conditions the returned results must match. All conditions are combined with AND

Per-query execution options, such as reading from the read replica or a custom database timeout

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied
in the given order. Results are additionally sorted by id ascending unless
id (or random) is part of the sort

remote_records (RecordCollection)

Returns records fetched from a remote endpoint. Sends a GET request to the
endpoint with filter, sort, page and per_page as query parameters and expects
a JSON response shaped like a records collection. An endpoint on a domain of
this platform is rendered directly. Not available in requests sent by another
platformOS instance. A failed request is logged and returns no results.

Endpoint that returns the records as JSON

Conditions the returned results must match. All conditions are combined with AND. Passed to the endpoint

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order passed to the endpoint

remote_users (UserCollection)

Returns users fetched from a remote endpoint. Sends a GET request to the
endpoint with filter, sort, page and per_page as query parameters and expects
a JSON response shaped like a users collection. An endpoint on a domain of
this platform is rendered directly. Not available in requests sent by another
platformOS instance. A failed request is logged and returns no results.

Endpoint that returns the users as JSON

Conditions the returned results must match. All conditions are combined with AND. Passed to the endpoint

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order passed to the endpoint

request (HTTPRequestContext)

Returns details of the current HTTP request. Deprecated, use context.headers and context.params in Liquid instead

streams (ActivityStreamsActivityStreamCollection)

Returns activities of a single activity feed, together with the number of unread activities

  • feed_id (ID)

Id of the feed within its type, usually the id of the object that owns it. Either feed_id or feed_name is required

Deprecated, use feed_id

Type of the feed, e.g. the type of the object that owns it

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

When true, marks the feed as read, so the unread count is reset

transactable (Transactable)

Returns a single legacy transactable. Deprecated, use records instead

  • creator_id (ID)

Id of the user who created the transactable

Unique identifier of the object

Slug of the transactable

transactable_type (TransactableType)

Returns a legacy transactable type. Deprecated, use admin_tables instead

Unique identifier of the object

Name of the transactable type

transactable_types (TransactableType)

Returns legacy transactable types. Deprecated, use admin_tables instead

  • ids (ID)

Ids of the transactable types

Names of the transactable types

transactables (TransactableCollection)

Returns legacy transactables. Deprecated, use records instead

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

user (User)

Returns the first user matching all given arguments, or null when no argument
is given. Soft deleted users are included unless is_deleted is false.
Deprecated, use users instead

Email of the user

Identifier of the object in an external system. Used mainly for
import/export, when a third party service is the source of truth

Unique identifier of the object

True returns only soft deleted users, false only not deleted ones

Per-query execution options, such as reading from the read replica or a custom database timeout

Slug of the user

users (UserCollection)

Returns users of the instance. Soft deleted users are included only when filtering by deleted_at.

Conditions the returned results must match. All conditions are combined with AND

Per-query execution options, such as reading from the read replica or a custom database timeout

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

  • per_page (Int)

Number of results per page, must be greater than 0

Sort order of the results. When several entries are given, they are applied
in the given order. Results are additionally sorted by id ascending unless
id (or random) is part of the sort

Contribute to this page How to Contribute

Contribute here

Questions?

We are always happy to help with any questions you may have.

contact us