---
title: "Read Organization Link Options"
method: GET
path: "/admin/organizations/link-options"
tags: ["admin", "organizations"]
---

# Read Organization Link Options

`GET /admin/organizations/link-options`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/admin/organizations/link-options`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Search one mirror for a record to link an organization to.

Separate from ``link-candidates``, which only returns what the matcher found by domain
or name. Every organization in the queue is there because that found nothing, so
picking a record has to be able to start from a search.

## Query parameters

- `source` string, required
- `search` string, nullable
- `limit` integer

## Headers

- `organization-id` string, nullable
- `timezone` string
- `x-user-id` string, nullable
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- OrganizationLinkOptions
  - `source` string, required
  - `options` LinkOption[]
    - `source` string, required
    - `id` string, required
    - `label` string, nullable
    - `detail` string, nullable
  - `truncated` boolean

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/86e2c2bd93af?raw)