curl --request GET \
--url http://localhost:3000/rs/documents/v1/ \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/documents/v1/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/rs/documents/v1/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/rs/documents/v1/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/rs/documents/v1/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/rs/documents/v1/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/documents/v1/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"type": "cerfa",
"origin": "site_upload",
"mimeType": "<string>",
"size": 536870912,
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"unitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"technicalInstallationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"buildingWorkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"downloadUrl": "<string>",
"folder": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"label": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
},
"createdByUser": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"actions": {
"canBeUpdated": true,
"canBeReplaced": true,
"canBeArchived": true,
"canBeUnarchived": true,
"canBeDeleted": true
},
"versionsCount": 0,
"source": {
"type": "report",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
}
],
"totalCount": 4503599627370495,
"pagination": {
"page": 4503599627370495,
"pageSize": 4503599627370495,
"totalPages": 4503599627370495
}
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}List the organization documents (paginated)
curl --request GET \
--url http://localhost:3000/rs/documents/v1/ \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/documents/v1/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/rs/documents/v1/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/rs/documents/v1/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/rs/documents/v1/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/rs/documents/v1/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/documents/v1/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"type": "cerfa",
"origin": "site_upload",
"mimeType": "<string>",
"size": 536870912,
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"unitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"technicalInstallationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"buildingWorkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"downloadUrl": "<string>",
"folder": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"label": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
},
"createdByUser": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"actions": {
"canBeUpdated": true,
"canBeReplaced": true,
"canBeArchived": true,
"canBeUnarchived": true,
"canBeDeleted": true
},
"versionsCount": 0,
"source": {
"type": "report",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
}
],
"totalCount": 4503599627370495,
"pagination": {
"page": 4503599627370495,
"pageSize": 4503599627370495,
"totalPages": 4503599627370495
}
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
0 < x <= 90071992547409910 < x <= 1000When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.
true
Extend options (JSON-encoded array, e.g. ?extend=["category"]):
- "folder": Include the containing folder (id, name), null when unclassified.
- "label": Include the linked label (id, name, color) when present.
- "created-by": Adds the document author (
createdByUserwith display name). - "actions-info": Adds
actions{ canBeUpdated, canBeReplaced, canBeArchived, canBeUnarchived, canBeDeleted }. - "versions-count": Adds
versionsCount, the number of past replacement versions. - "source": Include the carrier entity (report, contract, plan, building work) the document comes from, null for a plain upload.
folder, label, created-by, actions-info, versions-count, source Show child attributes
Show child attributes
Case-insensitive search across name and ref.
200"lobby"
Filter by one or more document types.
["cerfa", "security_notice"]
Filter by one or more document origins.
["site_upload", "building_work"]
Filter by folder id; the sentinel "none" means unclassified documents (no folder).
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Filter by one or more unit ids; the sentinel "none" matches documents linked to no unit, and "any" those linked to one.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Filter by one or more technical installation ids; the sentinel "none" matches documents linked to no technical installation, and "any" those linked to one.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Filter by one or more building-work ids; the sentinel "none" matches documents linked to no building-work, and "any" those linked to one.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Filter by one or more label ids; the sentinel "none" matches documents with no label.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Filter by one or more author user ids.
250^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$[
"550e8400-e29b-41d4-a716-446655440000",
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
]
When true, only archived documents; when false, only non-archived.
true
Filter by the creation-date range.
- Option 1
- Option 2
Show child attributes
Show child attributes
{
"start": "2026-01-01",
"end": "2026-01-31"
}