Get Multiple Documents With Pagination

POST

https://api.staple.io/v1/documents

POST

/v1/documents

$ curl -X POST https://api.staple.io/v1/documents \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json"

200Get Multiple Documents With Pagination

1 {
2   "getDocumentsByStatus": {
3     "data": [
4       {
5         "categorisation": null,
6         "company": "",
7         "completeness": 100,
8         "createdAt": 1589786505665,
9         "exportedAt": null,
10         "exportedBy": null,
11         "exportedType": null,
12         "fileName": "image1.png",
13         "fileURL": "documents/-aJWAt7wWN08OKdhrOcZyV_PiGd6KIL8byGI.png",
14         "id": 5965,
15         "layout": null,
16         "qid": 1,
17         "status": "REVIEWED",
18         "uid": 20,
19         "uploadedAt": 1591293714000,
20         "uploadedBy": "developer@gmail.com"
21       },
22       {
23         "categorisation": null,
24         "company": null,
25         "completeness": 100,
26         "createdAt": 1587372178772,
27         "exportedAt": null,
28         "exportedBy": null,
29         "exportedType": null,
30         "fileName": "invoice_#INV-20200220-178 (1).pdf",
31         "fileURL": "documents/0JjvRM2DGes9p-dFPmdbsv8Bxe_kl0wwitoc.png",
32         "id": 5699,
33         "layout": null,
34         "qid": 14,
35         "status": "REVIEWED",
36         "uid": 20,
37         "uploadedAt": 1587372179000,
38         "uploadedBy": "developer@gmail.com"
39       },
40       {
41         "categorisation": null,
42         "company": null,
43         "completeness": 100,
44         "createdAt": 1586432227890,
45         "exportedAt": null,
46         "exportedBy": null,
47         "exportedType": null,
48         "fileName": "5f13f120-7a56-11ea-8616-43562dbc2b0a-Dental-Invoice_1.JPG",
49         "fileURL": "documents/2GtIZEzFU7K38m1PYv8Tg9ZJsM2m8UVsvvOq.png",
50         "id": 5488,
51         "layout": null,
52         "qid": 1,
53         "status": "REVIEWED",
54         "uid": 20,
55         "uploadedAt": 1586432228000,
56         "uploadedBy": "developer@gmail.com"
57       },
58       {
59         "categorisation": null,
60         "company": null,
61         "completeness": 100,
62         "createdAt": 1586419480167,
63         "exportedAt": null,
64         "exportedBy": null,
65         "exportedType": null,
66         "fileName": "Central 24 Hour Clinic.jpg",
67         "fileURL": "documents/2XJaxSoG5apLvgWWGI1SI-MQTazFhb1BUggJ.png",
68         "id": 5436,
69         "layout": null,
70         "qid": 14,
71         "status": "REVIEWED",
72         "uid": 38,
73         "uploadedAt": 1586419480000,
74         "uploadedBy": "vovanluc1987@gmail.com"
75       },
76       {
77         "categorisation": null,
78         "company": null,
79         "completeness": 100,
80         "createdAt": 1587372066231,
81         "exportedAt": null,
82         "exportedBy": null,
83         "exportedType": null,
84         "fileName": "invoice_#INV-20200220-178 (1).pdf",
85         "fileURL": "documents/3h0v89MsnCcBb0kycXKjN04AoRV2UR0qNggF.png",
86         "id": 5698,
87         "layout": null,
88         "qid": 1,
89         "status": "REVIEWED",
90         "uid": 20,
91         "uploadedAt": 1587372066000,
92         "uploadedBy": "developer@gmail.com"
93       },
94       {
95         "categorisation": null,
96         "company": null,
97         "completeness": 100,
98         "createdAt": 1586419041503,
99         "exportedAt": null,
100         "exportedBy": null,
101         "exportedType": null,
102         "fileName": "aec0ead0-7a37-11ea-82e5-1132d154af42-GRH-Invoice_2.pdf",
103         "fileURL": "documents/7ivnDehxFZ9lSHqeSeB0EhMRs34zlKFXSofl.png",
104         "id": 5434,
105         "layout": null,
106         "qid": 1,
107         "status": "REVIEWED",
108         "uid": 38,
109         "uploadedAt": 1586419041000,
110         "uploadedBy": "vovanluc1987@gmail.com"
111       },
112       {
113         "categorisation": null,
114         "company": null,
115         "completeness": 100,
116         "createdAt": 1586418406163,
117         "exportedAt": null,
118         "exportedBy": null,
119         "exportedType": null,
120         "fileName": "345dda10-7a36-11ea-82e5-1132d154af42-GRH-Invoice_2.pdf",
121         "fileURL": "documents/7XcMJoUYypk6qYh6URyEhsyDBtT6KxJ0gM4m.png",
122         "id": 5430,
123         "layout": null,
124         "qid": 14,
125         "status": "REVIEWED",
126         "uid": 38,
127         "uploadedAt": 1586418406000,
128         "uploadedBy": "vovanluc1987@gmail.com"
129       },
130       {
131         "categorisation": null,
132         "company": null,
133         "completeness": 100,
134         "createdAt": 1586418971449,
135         "exportedAt": null,
136         "exportedBy": null,
137         "exportedType": null,
138         "fileName": "804029a0-7a37-11ea-82e5-1132d154af42-GRH-Invoice_1.pdf",
139         "fileURL": "documents/AA07-j9WOXGZQth4bLosuML62GQ2xacrPV5c.png",
140         "id": 5433,
141         "layout": null,
142         "qid": 1,
143         "status": "REVIEWED",
144         "uid": 38,
145         "uploadedAt": 1586418971000,
146         "uploadedBy": "vovanluc1987@gmail.com"
147       },
148       {
149         "categorisation": null,
150         "company": null,
151         "completeness": 100,
152         "createdAt": 1586418964896,
153         "exportedAt": null,
154         "exportedBy": null,
155         "exportedType": null,
156         "fileName": "80411400-7a37-11ea-82e5-1132d154af42-GRH-Invoice_2.pdf",
157         "fileURL": "documents/AkeCjDcKGgUqyf3Xl22HBDUJh4OxD0NQzCxu.png",
158         "id": 5432,
159         "layout": null,
160         "qid": 14,
161         "status": "REVIEWED",
162         "uid": 38,
163         "uploadedAt": 1586418965000,
164         "uploadedBy": "vovanluc1987@gmail.com"
165       },
166       {
167         "categorisation": null,
168         "company": null,
169         "completeness": 100,
170         "createdAt": 1586425103460,
171         "exportedAt": null,
172         "exportedBy": null,
173         "exportedType": null,
174         "fileName": "ce711130-7a45-11ea-b5ce-17ed1a020c16-GP-Clinic-Invoice_2.pdf",
175         "fileURL": "documents/HgI718EX1Y1hOk0tE6U9SRQg0EAswFF0tR0m.png",
176         "id": 5469,
177         "layout": null,
178         "qid": 1,
179         "status": "REVIEWED",
180         "uid": 38,
181         "uploadedAt": 1586425103000,
182         "uploadedBy": "vovanluc1987@gmail.com"
183       }
184     ],
185     "pageInfo": {
186       "hasNextPage": true,
187       "hasPreviousPage": false,
188       "lastCursor": 5469
189     },
190     "total": 24
191   }
192 }

Get a list of all the documents and their status within a single queue.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Request

This endpoint expects an object.

filterobjectOptional

Authentication

Request

Response