Skip to navigation
V2Reconciliation

List Linking Sets

View as Markdown

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.

Authentication

x-api-keystring
API key issued by Staple.
AuthorizationBearer
JWT obtained from the login endpoint.

Query parameters

searchstringOptional

Case-insensitive match on the linking set name.

statusenumOptional
Return only linking sets in this lifecycle state.
Allowed values:
limitintegerOptional<=200Defaults to 50
Page size. Defaults to 50 and is capped at 200.
offsetintegerOptionalDefaults to 0
Number of records to skip for pagination.

Response

OK