Get Matching Collections

GET

https://api.staple.io/v1/matching/collections

GET

/v1/matching/collections

$ curl https://api.staple.io/v1/matching/collections \
>      -H "x-api-key: <apiKey>"

200Get Matching Collections

1 {
2   "getMatchingCollections": [
3     {
4       "collectionQueues": null,
5       "companyId": 1,
6       "createdAt": 1611312132120,
7       "currentVersionId": "dfb0c18a-cde9-4d62-bed4-594e86922472",
8       "id": 3,
9       "name": "Joshs sample Queue",
10       "numMatchedDocs": 0,
11       "numUnmatchedDocs": 1,
12       "uid": 1,
13       "updatedAt": 1713333098768
14     },
15     {
16       "collectionQueues": null,
17       "companyId": 1,
18       "createdAt": 1611312132120,
19       "currentVersionId": "dfb0c18a-cde9-4d62-bed4-594e86922472",
20       "id": 4,
21       "name": "Joshs sample Queue 2",
22       "numMatchedDocs": 0,
23       "numUnmatchedDocs": 1,
24       "uid": 1,
25       "updatedAt": 1713333098768
26     }
27   ]
28 }

Lists all matching collections in your organisation. Each collection includes its ID, the number of matched and unmatched documents, and the current version ID. Use this to discover the collection IDs required by the matching tuple endpoints.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Authentication

Response