Documents
List organization documents
Lists documents across all projects in an organization with filtering
Authorization
ApiKeyAuth x-api-key<token>
In: header
Path Parameters
organizationId*string
Format
uuidQuery Parameters
type?|array<>
status?string
Value in
- "active"
- "archived"
accessLevel?string
Value in
- "public"
- "restricted"
- "internal"
policyType?string
Length
length <= 256offset?integer
Range
0 <= valueDefault
0limit?integer
Range
1 <= value <= 1000Default
100sort?string
order?string
countOnly?boolean
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents"{ "offset": 0, "count": 0, "total": 0, "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "name": "string", "description": "string", "type": "policy", "accessLevel": "public", "requiredAgreementId": "a75a02fb-e0ea-425d-885c-3e81bc78c47c", "allowlistEmails": [ "user@example.com" ], "allowlistDomains": [ "string" ], "tags": [ "string" ], "frameworks": [ "string" ], "slug": "string", "policyType": "string", "policyTemplateVersion": 0, "formSubmissionId": "string", "migratedFromPolicyId": "f716dcd6-fe73-4bde-bd2d-296a34e980b0", "assets": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "format": "html", "language": "string", "body": "string", "file": { "bucket": "string", "key": "string", "size": 0, "fileName": "string", "contentType": "string", "etag": "string", "sha256": "string" }, "version": 0, "dateCreated": 0, "dateUpdated": 0 } ], "question": "string", "url": "http://example.com", "version": 0, "publishedReleaseId": "string", "hasUnpublishedChanges": true, "templateUpdateAvailable": true, "status": "active", "dateCreated": 0, "dateUpdated": 0 } ]}