--- title: "List documents" method: GET path: "/v1/accounts/{accountId}/documents" tags: ["Documents"] --- # List documents `GET /v1/accounts/{accountId}/documents` ## Request - Base URL: `https://api.assinafy.com.br` - URL: `https://api.assinafy.com.br/v1/accounts/{accountId}/documents` - Auth: one of: - HTTP bearer - API key in header `X-Api-Key` List documents of the workspace, most recently updated first. Every row includes its `assignment` and `pages`; an `expand` parameter is ignored. For a lighter list without them, use `GET /v1/accounts/{accountId}/documents/search`. [Copy as Markdown](https://api.assinafy.com.br/v1/docs/markdown?method=get&path=%2Fv1%2Faccounts%2F%7BaccountId%7D%2Fdocuments) [Open in ChatGPT](https://chatgpt.com/?q=Read%20the%20API%20documentation%20at%20https%3A%2F%2Fapi.assinafy.com.br%2Fv1%2Fdocs%2Fmarkdown%3Fmethod%3Dget%26path%3D%252Fv1%252Faccounts%252F%257BaccountId%257D%252Fdocuments%20and%20help%20me%20integrate%20this%20endpoint.) [Open in Claude](https://claude.ai/new?q=Read%20the%20API%20documentation%20at%20https%3A%2F%2Fapi.assinafy.com.br%2Fv1%2Fdocs%2Fmarkdown%3Fmethod%3Dget%26path%3D%252Fv1%252Faccounts%252F%257BaccountId%257D%252Fdocuments%20and%20help%20me%20integrate%20this%20endpoint.) ## Path parameters - `accountId` string, required ## Query parameters - `status` string - `method` 'virtual' | 'collect' - `search` string - `tags` string - `sort` string - `page` integer - `per-page` integer ## Response `200` A page of documents - object: Standard success wrapper. Operations add their own `data`. - `status` integer: HTTP status code, mirrored in the body. - `message` string: Human-readable message; empty on success. - `data` Document[] - `resource` string: Present in single-resource responses. - `id` string - `account_id` string - `template_id` string, nullable - `name` string - `status` string: Status code — see GET /v1/documents/statuses. - `artifacts` object: Artifact download URLs keyed by name. Always `original`, plus `thumbnail` once one exists. A certificated document also carries `certificated`, `certificate-page` and `bundle`, and `pades` when it was signed with a digital certificate — the PAdES version holds the signers' ICP-Brasil signatures, which certification flattens out of the certificated PDF. - `is_closed` boolean - `signing_url` string - `verification_code` string, nullable: The code printed on the certificate page. Anyone can check it with `GET /v1/documents/{verification_code}/verify` or on `verification_url`. `null` until the document is `certificated`, and on documents certificated before verification codes existed. - `verification_url` string, uri, nullable: The public verification page for this document. `null` until the document is `certificated`. - `decline_reason` string, nullable - `declined_by` Signer: A signing party belonging to a workspace account. - `resource` string: Present in single-resource responses. - `id` string - `full_name` string - `email` string, email, nullable - `whatsapp_phone_number` string, nullable: E.164 format; normalized on save. - `government_id` string, nullable: Signer's normalized CPF (11 digits) or CNPJ (14 characters; may be alphanumeric). - `has_accepted_terms` boolean - `tags` object[] - `id` string - `name` string - `assignment` Assignment: A request for signers to sign a document. - `resource` string - `id` string - `document_id` string, nullable: The document this assignment belongs to. `null` only if the document was deleted. - `created_at` string, date-time - `sender_email` string, email, nullable: Email of the user who sent the document; null once that user has deleted their account. - `method` 'virtual' | 'collect' - `expires_at` string, date-time, nullable - `message` string, nullable - `signers` AssignmentSigner[] - `resource` string: Present in single-resource responses. - `id` string - `full_name` string - `email` string, email, nullable - `whatsapp_phone_number` string, nullable: E.164 format; normalized on save. - `government_id` string, nullable: Signer's normalized CPF (11 digits) or CNPJ (14 characters; may be alphanumeric). - `has_accepted_terms` boolean - `verification_method` string, nullable - `notification_methods` string[], nullable - `step` integer, nullable: Sequential signing step (defaults to 1). - `notified` boolean, nullable - `identity_verification_status` 'Pending' | 'InReview' | 'Approved' | 'Declined' | 'Expired' | 'Abandoned', nullable: Latest identity-document verification status; `InReview` means the account must decide it before the document can be certificated. - `completed` boolean, nullable: Only present in account-owner contexts. - `notification_history` NotificationHistoryEntry[], nullable: Per-channel delivery history for this signer (email + WhatsApp), most-recent send order. - `event` string - `status` 'sent' | 'failed' - `error_code` string, nullable - `error_message` string, nullable - `sent_at` string, date-time, nullable - `failed_at` string, date-time, nullable - `copy_receivers` object[] - `items` AssignmentItem[] - `id` string - `page` DocumentPage - `id` string - `number` integer - `height` integer - `width` integer - `download_url` string - `signer` object: Signer responsible for this item. - `field` object, nullable: Field definition associated with the item. - `display_settings` unknown - `value` unknown - `completed` boolean - `summary` AssignmentSummary - `signer_count` integer - `completed_count` integer - `signers` object[] - `signing_urls` SigningUrl[] - `signer_id` string - `url` string - `pages` DocumentPage[]: The document's pages. Included on the same responses as `assignment`, and also on the upload response. - `id` string - `number` integer - `height` integer - `width` integer - `download_url` string - `created_at` string, date-time - `updated_at` string, date-time ## Other responses - `401`: Missing or invalid credentials. - `500`: Unexpected server error. ## Changes - **2026-10-26** `f7da81a5567e`: 1 breaking - the response property `allOf[subschema #2]/data/items/assignment/oneOf[#/components/schemas/Assignment]/sender_email` became nullable for the status `200` - **2026-10-22** `dda5f0d393cb`: 4 info - added the optional property `allOf[subschema #2]/data/items/assignment/oneOf[#/components/schemas/Assignment]/created_at` to the response with the `200` status - added the optional property `allOf[subschema #2]/data/items/assignment/oneOf[#/components/schemas/Assignment]/document_id` to the response with the `200` status - added the optional property `allOf[subschema #2]/data/items/verification_code` to the response with the `200` status - added the optional property `allOf[subschema #2]/data/items/verification_url` to the response with the `200` status - **2026-10-15** `da98836f863b`: 1 info - added the optional property `allOf[subschema #2]/data/items/assignment/oneOf[#/components/schemas/Assignment]/signers/items/allOf[subschema #2]/identity_verification_status` to the response with the `200` status - …earlier changes not shown [Operation history](https://skmtc.dev/assinafy/apis/assinafy-api-reference/changes/v1/accounts/:accountId/documents/get.md) --- [API](https://skmtc.dev/assinafy/apis/assinafy-api-reference.md) - [All operations](https://skmtc.dev/assinafy/apis/assinafy-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/assinafy/apis/assinafy-api-reference/revisions/f7da81a5567e?raw)