Domain Query - Get a List of Records from a Domain

get

https://{environment}.origamirisk.com/OrigamiApi/api/{domain}/Query

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

domain

string

required

Defaults to Claim

This should match to the Domain Name in the system. It is case-sensitive. For Client Defined Entities it should start with "Custom.".

Query Params

columns

string

required

This field lets you control which columns (fields) come back in the API response and what they are called.

If not provided, then all fields on the record are returned.

Here is what each part means:

1. Choose which columns you want

You pass a comma separated list of field names.

Example:
Location.Name, ClaimNumber, LossDate

If you do not pass anything, the API will return all columns it normally uses.

2. Rename columns using aliases

You can rename a column in the response by adding as AliasName.

Example:
Location.Name as LocationName

This means:

The API reads data from Location.Name
The response JSON will contain LocationName

This is helpful to:

Make names shorter
Avoid dots in response keys
Match frontend or reporting naming conventions

3. Referencing related or coded fields

Some fields are associations or coded values. These do not return anything unless you ask for a specific property on them.

Example:

Custom2Code → returns null
Custom2Code.Description → returns the human readable text

So:

The code object itself does not have a direct value
You must request a specific attribute of it, like Description, Code, etc.

4. Putting it all together

Example query:
Location.Name as LocationName, Custom2Code.Description as CustomReason

Result:

You get only the fields you asked for
You control the field names in the response
You correctly extract values from coded or related fields

filter

string

Filter for a specific record using criteria as defined by Origami Advanced Search syntax

sort

string

Columns to sort by. Similar syntax to sorting in Views.

startAt

integer

Defaults to 0

Default is 0. If you are fetching subsequent pages of data indicate the record to start with.

take

integer

Defaults to 30

This is the number of records that can be included in the response. Default is 30 records. Maximum is capped at 100.

LINQFilter

string

Optional record filter criteria in C# LINQ syntax. Only to be used in cases where filter syntax does not meet needs.

suppressNullColumns

boolean

Defaults to false

When enabled, the response will omit any column that contains no data across the entire result set. A column is only suppressed if every record in the response has a null value for that field. If at least one record has a non-null value, the column is retained and included for all records, ensuring that the shape of each record in the result set remains consistent.

includeTotalCount

boolean

Defaults to false

When true, includes the total count of all records. Defaults to false. May impact performance on large datasets.

resolveAssociationNames

boolean

Defaults to false

This input modifies how values are returned for the columns parameter.
Most columns will represent individual fields that are retrieved directly from the record being queried. However, in some cases you may want to name a related "object" as a column you wish to retrieve. These are referred to as association fields.

When resolveAssociationNames is set to true, the API will attempt to resolve any requested association fields and return a readable, display-friendly value for them. When set to false (or omitted), association fields will return null unless the record natively stores a value for that column.

Understanding association fields

This has useful roots stemming from Origami's intuitive UI, where data is often presented in tables that list default "columns" for a given record type. While these columns appear as simple fields in the UI/table, some of them are actually representations of related records.

For example, a Claim is associated with a Location. In tables, Location appears as a single column, but the Claim record itself does not store the Location’s descriptive information. Instead, it stores only a reference (such as LocationID) to the related Location record. The readable Location value shown in the UI (for example, LocationNumber - Name) is constructed from multiple fields on that related Location record.
Because these relationship-based values are surfaced as columns, it is reasonable for API consumers to request them as if they were simple fields. Association resolution exists to support this usage and return meaningful data rather than an empty value.

Behavior when association resolution is enabled

When resolveAssociationNames=true and a requested column is an association field:

The API interprets the request as an intent to retrieve the displayed value for the related/associated record.

The related record is looked up using the stored reference (for example, LocationID).

If the related record can be resolved, the API returns a readable string representation (such as LocationNumber - Name).

If the related record cannot be found, the value will remain null.

This mirrors how related values are displayed throughout Origami tables and reports.

Examples

Without association resolution
GET /api/Claim/Query?columns=IncidentID,LocationID,Location

Sample Reponse:
{
  "IncidentID": 10752,
  "LocationID": 22177,
  "Location": null
}

With association resolution
GET /api/Claim/Query?columns=IncidentID,LocationID,Location&resolveAssociationNames=true

{
  "IncidentID": 10752,
  "LocationID": 22177,
  "Location": "35 - Chicago"
}

Response

1. Choose which columns you want

2. Rename columns using aliases

3. Referencing related or coded fields

4. Putting it all together

200