The documents endpoint returns all documents in your organization. Use the returned document IDs when creating attestation requests. Each document in the response includes attestation summary counts and metadata about its published revision status.
Endpoint GET https://api.clearpolicy.app/v1/documents
Authentication Required. Pass your OAuth bearer token in the Authorization header.
Query parameters Filter documents whose name contains this value (case-insensitive partial match).
Number of results per page. Must be between 1 and 100.
Example request curl "https://api.clearpolicy.app/v1/documents?per_page=25&page=1" \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response fields The ULID of the document.
The ULID of the organization the document belongs to.
The display name of the document.
The default attestation type for this document. One of "acknowledgment" or "signature". When creating an attestation request you can override this per-request.
How often (in days) the document requires re-attestation, or null if renewal is not configured.
Whether attestation requests are automatically re-sent when a renewal is due.
Whether the document has a published revision. Only documents with a published revision can be sent via the API.
ISO 8601 timestamp of the most recent document revision, or null if no revision exists.
A summary of attestation statuses across all contacts assigned to this document. Contacts who have attested the current published revision.
Contacts with an outstanding attestation request not yet completed.
Contacts who attested a previous revision but not the current one.
Contacts assigned to the document who have not been sent a request.
Contacts whose attestation has expired and renewal is due.
Total number of contacts assigned to the document.
ISO 8601 timestamp of when the document was created.
ISO 8601 timestamp of the last update.
Example response { "data" : [ { "id" : "01kg82xqfx6fvr046d15hnfmjv" , "organization_id" : "01jz91kq3m0gar5btepwxvncde" , "name" : "Employee Handbook" , "default_attestation_type" : "signature" , "renewal_interval_days" : 365 , "auto_renew" : true , "has_published_revision" : true , "last_updated_at" : "2024-03-01T09:00:00.000000Z" , "attestation_counts" : { "attested_latest" : 10 , "pending_attested" : 2 , "attested_outdated" : 1 , "unrequested" : 4 , "renewal_due" : 3 , "total" : 20 }, "created_at" : "2024-01-01T00:00:00.000000Z" , "updated_at" : "2024-03-01T09:00:00.000000Z" } ], "links" : { "first" : "https://api.clearpolicy.app/v1/documents?page=1" , "last" : "https://api.clearpolicy.app/v1/documents?page=3" , "prev" : null , "next" : "https://api.clearpolicy.app/v1/documents?page=2" }, "meta" : { "current_page" : 1 , "from" : 1 , "last_page" : 3 , "per_page" : 25 , "to" : 25 , "total" : 62 } }
Only documents with has_published_revision: true can be used when creating attestation requests. Attempting to send an unpublished document will return a 400 error.
