List Reference (find where)
Find a list of Reference records that match the specified criteria.
Tip: All query parameters accept multiple values for array filtering — e.g. ?id=1&id=2 or ?id[]=1&id[]=2. This also works within the where parameter: ?where={"id":[1,2,3]}.
Note: The per-attribute filter parameters and the where parameter are mutually exclusive. If where is supplied, the per-attribute filters are ignored — put all filter criteria inside where instead. limit, skip, sort, and populate are unaffected.
query Parameters
statusFilter by status (1 = active, 0 = inactive)
referenceFamilyID of the associated ReferenceFamily record
shortCodeIdentifier of the referenced item on the external platform (e.g. a Jira issue key).
scopePlatform-dependent scope (e.g. project, repository, board). Set automatically by clients and used for filtering.
pageTitleFull name of the referenced item on the external platform.
externalIdID of the referenced item in the external system.
idFilter by record ID
createdAtFilter by creation date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.sssZ). This is an exact match filter; for range queries (greater than, less than), use the where parameter instead
updatedAtFilter by last update date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.sssZ). This is an exact match filter; for range queries (greater than, less than), use the where parameter instead
whereA JSON-encoded Waterline criteria for advanced filtering. Only whitelisted criteria are supported: status, referenceFamily, shortCode, scope, pageTitle, externalId, id, createdAt, updatedAt. Sub-attribute modifiers such as startsWith, >=, <=, >, <, and != are supported on any whitelisted criterion. The contains modifier is not supported on this model.
Note: If where is supplied, the per-attribute filter query parameters above are ignored — where is the entire criteria. (limit, skip, sort, and populate are unaffected.) To combine filters, put them all inside where.
e.g. ?where={"startDate":{">=":"2026-06-01","<":"2026-07-01"}}
limitThe maximum number of records to return. Defaults to 500000, capped at 500000.
skipThe number of records to skip (useful for pagination).
sortThe sort order. By default, returned records are sorted by primary key value in ascending order.
e.g. ?sort=lastName%20ASC
List Reference (find where) › Responses
Responds with a paged list of Reference records that match the specified criteria
Get Reference (find one)
Update Reference
Partially update an existing Reference record. Despite using PUT, this endpoint applies PATCH semantics — only the fields included in the request body are modified; omitted fields are left unchanged.
path Parameters
idThe desired Reference record's primary key value
Update Reference › Request Body
Aerion model Reference
Update Reference › Responses
Responds with the newly updated Reference record as a JSON dictionary
Aerion model Reference