Querying API (v3.0)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

Use the Querying API to fetch multiple pages of search results sequentially. This REST API lets you to retrieve entities that match specific criteria.

When using the Querying API, keep the following considerations in mind:

• Due to deep paging considerations the querying endpoint is limited to retrieve up to 10,000 results.
• When search results are sorted on a property and there are multiple results that have the same value for that property, then those results are displayed in random order. To address this limitation, use a secondary sort property as a tie-breaker.
• With full-text search, do not use the following characters: «, », ÷,×, ¦, ¤, ⋇, or ؉. Do not combine special characters and wildcards within the same word. For example, use invoice reort instead of invoice-reort to ensure consistent results like invoice-report.
• The FullText search property only supports the == operator, but can be negated.
• When you run a query, make sure you include all the entity members that you want to retrieve. If you omit the members parameter, the response will return all the existing entity members (all properties, all relations, and so on). To ensure optimal performance, only request the members you actually need.
• The API is configured to only load the related paths that are specified in a query. If you don't specify related path relations in your query, the response won't return any.