Read data - Bonx

List queries accept four main arguments:

where filters the results;
orderBy defines their order;
limit defines the maximum number of results;
offset skips the first results.

You can use several arguments in the same query.

Filter results

Add where and specify an operator for each field that you want to filter.

query {
  receivings(where: { name: { _eq: "REC-0412" } }) {
    id
    name
  }
}

The common operators are:

Operator	Function
`_eq`, `_neq`	Is equal to, is not equal to
`_in`, `_nin`	Is in a list, is not in a list
`_gt`, `_gte`, `_lt`, `_lte`	Compares numbers or dates
`_like`, `_ilike`	Searches text with `%` as a wildcard
`_isNull`	Checks if a field is empty

_ilike ignores differences between uppercase and lowercase characters. Combine conditions with _and, _or, or _not.

query {
  receivings(where: { _and: [{ createdAt: { _gte: "2026-08-01" } }, { site: { name: { _eq: "North Workshop" } } }] }) {
    id
    name
  }
}

The site: { name: … } filter uses related data. It selects receivings from the name of their site.

Sort and paginate

This query returns the 50 latest receivings:

query {
  receivings(orderBy: { createdAt: DESC }, limit: 50, offset: 0) {
    id
    name
    createdAt
  }
}

To read the next page, add the limit value to offset. Keep the same orderBy for every page. Otherwise, some rows can be repeated or missing. Select a relation like another field. The following query returns a receiving, its supplier, its lines, and the article for each line.

query {
  receivings(where: { name: { _eq: "REC-0412" } }) {
    id
    name
    supplier: supplierOrganization {
      id
      name
    }
    lines {
      id
      quantity
      article {
        id
        articleCode
        name
      }
    }
  }
}

supplier is an alias. It replaces the supplierOrganization name in the response. A nested relation can also have its own where argument.

Count results

Use an operation that ends with Aggregate to calculate a value across several records.

query {
  receivingsAggregate(where: { createdAt: { _gte: "2026-08-01" } }) {
    aggregate {
      count
    }
  }
}

Depending on the field type, you can also use sum, avg, min, or max. The server calculates the result without returning every row.

The custom tables and fields in your space use the same filters and relations.

​Filter results

​Sort and paginate

​Read related data

​Count results

Filter results

Sort and paginate

Read related data

Count results