> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.staple.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.staple.ai/_mcp/server.

# List Linking Sets

GET https://api.staple.io/reconciliation/v1/linking-sets

Lists the reconciliation linking sets configured for the tenant. A linking set is one reconciliation setup — which document groups are linked and which fields are compared.

This is an index, not the authoring tree: each item carries the `uuid`, name, status, and version only. Use the `uuid` with the document set endpoints below.

Requires reconciliation v2 on the organisation; other tenants receive `404`.

Reference: https://docs.staple.ai/api-reference/v2/reconciliation/list-linking-sets

## Authentication

- `x-api-key` header (required) — API key issued by Staple.
- `Authorization` header (bearer token, required) — JWT obtained from the login endpoint.

## Request

### Query parameters

- `search` (string, optional) — Case-insensitive match on the linking set name.
- `status` (enum, optional) — Return only linking sets in this lifecycle state.
  - Allowed values: `draft`, `active`, `archived`
- `limit` (integer, optional, default: 50) — Page size. Defaults to 50 and is capped at 200.
- `offset` (integer, optional, default: 0) — Number of records to skip for pagination.

## Response

### 200

OK

## Examples

**Response**

```json
{
  "items": [
    {
      "created_at": "2026-08-01T10:00:00Z",
      "description": "Invoice vs purchase order and delivery note",
      "name": "Invoice 3-way match",
      "owner": "ap.controller@example.com",
      "status": "active",
      "updated_at": "2026-08-02T11:00:00Z",
      "uuid": "7c2a1b90-4d3e-4f81-9a0c-11b2c3d4e5f6",
      "version": "2026-01-14"
    }
  ],
  "limit": 50,
  "offset": 0,
  "total_count": 1
}
```

**SDK Code**

```python List Linking Sets
import requests

url = "https://api.staple.io/reconciliation/v1/linking-sets"

querystring = {"limit":"50","offset":"0","search":"invoice","status":"active"}

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript List Linking Sets
const url = 'https://api.staple.io/reconciliation/v1/linking-sets?limit=50&offset=0&search=invoice&status=active';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go List Linking Sets
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staple.io/reconciliation/v1/linking-sets?limit=50&offset=0&search=invoice&status=active"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby List Linking Sets
require 'uri'
require 'net/http'

url = URI("https://api.staple.io/reconciliation/v1/linking-sets?limit=50&offset=0&search=invoice&status=active")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java List Linking Sets
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.staple.io/reconciliation/v1/linking-sets?limit=50&offset=0&search=invoice&status=active")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php List Linking Sets
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.staple.io/reconciliation/v1/linking-sets?limit=50&offset=0&search=invoice&status=active', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp List Linking Sets
using RestSharp;

var client = new RestClient("https://api.staple.io/reconciliation/v1/linking-sets?limit=50&offset=0&search=invoice&status=active");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift List Linking Sets
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.staple.io/reconciliation/v1/linking-sets?limit=50&offset=0&search=invoice&status=active")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```