Overview

Queries associations between a parent record with a child record. Provide either a parent domain, a child domain, or both to filter results. If only the parent is specified, all links from that parent are returned. If only the child is specified, all links to that child are returned.

The response contains metadata about the Link/Association (IDs, relationship), not the full parent or child record fields. To hydrate linked records, use the returned IDs in follow-up calls: (ChildID with GET /api/Contact/{id} or GET /api/File/Query, and ParentID with GET /api/{domain}/{id}).

Record Identification

Parent and child records can be identified in two ways:

1. By primary key (preferred): Provide parentRecordID or childRecordID.
2. By match field: Provide both a key value and a field name (e.g., parentRecordKey=POL-2026-001 + parentRecordMatchField=PolicyNumber). Only text or numeric fields are accepted.

If both a primary key and a match field are provided for the same side, the primary key takes priority and the match field is ignored.

For this Query endpoint, record identifiers are optional filters. You can provide just a domain to get all links for that domain, or narrow results by specifying a particular record.

Preconditions

• At least one of parentDomain or childDomain must be provided.
• The authenticated user must have View permissions on the specified domain(s).
• The child domain must be a linkable child type.

Notes

• Link columns do not support drill-down properties. Use the returned ParentID or ChildID in a subsequent domain query to get full field values.
• If a match field/key pair is provided but does not resolve to a record, the endpoint returns an error.
• The relationship parameter is only applicable when querying Contact links.

Examples

Scenario 1: Query all contacts linked to a specific claim:

GET /api/Link/Query?columns=LinkID,ParentID,ChildID,ContactTypeID&parentDomain=Claim&parentRecordID=5001&childDomain=Contact

200 OK
{
  "Domain": "Link",
  "Columns": "LinkID,ParentID,ChildID,ContactTypeID",
  "StartAt": 0,
  "Take": 30,
  "Sort": null,
  "List": [
    {
      "LinkID": 101,
      "ParentID": 5001,
      "ChildID": 2001,
      "ContactTypeID": 3
    },
    {
      "LinkID": 102,
      "ParentID": 5001,
      "ChildID": 2005,
      "ContactTypeID": 7
    }
  ]
}

Scenario 2: Query links using a match field instead of primary key:

GET /api/Link/Query?columns=LinkID,ParentID,ChildID&parentDomain=Policy&parentRecordKey=POL-2026-001&parentRecordMatchField=PolicyNumber&childDomain=Contact

200 OK
{
  "Domain": "Link",
  "Columns": "LinkID,ParentID,ChildID",
  "StartAt": 0,
  "Take": 30,
  "Sort": null,
  "List": [
    {
      "LinkID": 250,
      "ParentID": 67890,
      "ChildID": 3001
    }
  ]
}

Scenario 3: Neither parent nor child domain provided:

GET /api/Link/Query?columns=LinkID

500 Internal Server Error
"Unable to get Links. You must provide at least one of Parent Domain or Child Domain to Query Links."