> ## Documentation Index
> Fetch the complete documentation index at: https://developers.logicgate.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Link records by identifiers

> **Permissions:** Admin access

Find and link records to one another using PrimaryField value, record name, or record ID. Records not found or not in the provided workflow are skipped silently.



## OpenAPI

````yaml POST /api/v1/records/link-by-identifiers
openapi: 3.1.0
info:
  title: Risk Cloud API
  description: >-
    The Risk Cloud API is a collection of RESTful API endpoints that empower you
    and your team to directly integrate, automate, and build with the Risk
    Cloud. Risk Cloud API endpoint payloads are JSON based, with some endpoints
    supporting exports in CSV and XSLX formats for flexible integration.


    This API documentation showcases our Risk Cloud API v1, containing a variety
    of endpoints with continued support for enabling integrations with the Risk
    Cloud.


    Visit the [LogicGate Risk Cloud Developer
    Portal](https://www.logicgate.com/developer/) to get started with building
    your custom integration with quick start guides, usage guides, release
    notes, and more. Or download the [v1 OpenAPI
    specification](/legacy-openapi.json).


    Explore our [Risk Cloud API v2](https://docs.logicgate.com/v2/index.html)
    endpoints and documentation as well. [Risk Cloud API
    v2](https://docs.logicgate.com/v2/index.html) is our collection of API-First
    endpoints that are tailor made for our developer users, offer concise and
    highly documented details, are supported by a [Postman
    collection](https://www.postman.com/logicgate-postman/workspace/logicgate-risk-cloud-api/collection/29257227-de8d264b-6eeb-4177-bea6-2da0a8cabffc)
    and [v2 OpenAPI specification](https://github.com/LogicGateTech/openapi),
    and contain our latest API endpoint releases.
  contact:
    name: developer-relations@logicgate.com
    email: developer-relations@logicgate.com
  version: v2026.11.0
servers:
  - url: https://{subdomain}.logicgate.com
    description: Your Risk Cloud environment.
    variables:
      subdomain:
        description: Your Risk Cloud environment's subdomain (e.g. `qa`).
        default: your-instance
security:
  - ApiToken: []
  - basic: []
tags:
  - name: Authentication
    description: >-
      Getting Started: How to create an [API Access
      Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/)
      to begin integrating with the Risk Cloud API
  - name: Attachment
    description: Endpoints for uploading, downloading, and retrieving record attachments.
  - name: Field
    description: Endpoints for creating, updating, and querying fields.
  - name: Principal
    description: >-
      Endpoints for the authenticated principal to view and manage their own
      details.
  - name: Record Audit
    description: Endpoints for retrieving record audit history and productivity data.
  - name: Step
    description: Endpoints for retrieving steps and the steps a user can access.
  - name: Table Report
    description: Endpoints for retrieving and managing table reports.
  - name: User Group
    description: Endpoints for managing user groups and their membership.
externalDocs:
  description: Developer Portal
  url: https://www.logicgate.com/developer/
paths:
  /api/v1/records/link-by-identifiers:
    post:
      tags:
        - Record
      summary: Link records by identifiers
      description: >-
        **Permissions:** Admin access


        Find and link records to one another using PrimaryField value, record
        name, or record ID. Records not found or not in the provided workflow
        are skipped silently.
      operationId: linkByIdentifiers
      parameters:
        - name: strategy
          in: query
          description: >-
            How to resolve links against existing mappings. Defaults to
            RESPECT_MAPPING.
          required: false
          schema:
            type: string
            default: RESPECT_MAPPING
            description: >-
              Determines the linking strategy when records have pre-existing
              link.
            enum:
              - RESPECT_MAPPING
              - REMOVE_EXISTING
      requestBody:
        content:
          application/json:
            schema:
              type: array
              description: >-
                The records to link, each identified by PrimaryField value,
                record name, or record ID.
              items:
                $ref: '#/components/schemas/RecordLinkIdentifier'
        required: true
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppStatusResponse'
        '403':
          description: Forbidden
components:
  schemas:
    RecordLinkIdentifier:
      type: object
      description: Specifies record look up method for linking endpoint.
      properties:
        primaryFieldValue:
          type: string
          description: Value of primary field to search for.
        recordId:
          type: string
          description: Id of record to search for. Used when looking up a single record.
        recordName:
          type: string
          description: Name of record to search for. (i.e. risk-83, control-39, etc.)
        workflowId:
          type: string
          description: >-
            When searching by primary field value, specifies the id of the
            workflow.
        type:
          type: string
          enum:
            - PRIMARY_FIELD_VALUE
            - RECORD_ID
            - RECORD_NAME
      required:
        - primaryFieldValue
        - recordId
        - recordName
        - workflowId
    AppStatusResponse:
      type: object
      additionalProperties: true
      description: >-
        An RFC 9457 problem detail. Extension members are written as top-level
        fields rather than under `properties`, and `status` is a string, to stay
        compatible with pre-RFC 9457 clients. Empty fields are omitted.
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: string
          example: '400'
        detail:
          type: string
        instance:
          type: string
          format: uri
        message:
          type: string
          description: Legacy alias of `detail`.
  securitySchemes:
    ApiToken:
      type: http
      scheme: bearer
      bearerFormat: API Token
    basic:
      type: http
      scheme: basic

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.