---
title: "Get user's documents"
method: GET
path: "/v2/organizations/{org_unique_id}/documents/search"
---

# Get user's documents

`GET /v2/organizations/{org_unique_id}/documents/search`

## Request

- Base URL: `https://api.signnow.com`
- URL: `https://api.signnow.com/v2/organizations/{org_unique_id}/documents/search`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/signnow/apis/signnow-api/docs/v2/organizations/:org_unique_id/documents/search/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows API users to search the documents of an organization's users. Available only to the Administrator of the organization. 

The `filters` query parameter is required. It is an array of filters and must contain at least one filter, for example `?filters=[{"name":{"type":"=","value":"sample name"}}]`. A request without `filters` returns an error.

**Pay attention**: emails must be encoded in such format `sample_name%40email.com`

## Response `200`

Search by Signer email

- object
  - `data` object[]: Documents that match the search filters.
    - `id` string: Unique identifier of the document.
    - `tags` object[]: List of tags assigned to the document.
      - `name` string: Name of the tag.
      - `type` string: Type of the tag, for example `system`.
    - `lines` object[]: List of line elements drawn on the document.
    - `owner` string: Email address of the document owner.
    - `pages` object[]: List of document page images with size metadata.
      - `src` string: URL of the page image.
      - `size` object: Size of the page.
        - `width` number: Width of the page, in pixels.
        - `height` number: Height of the page, in pixels.
    - `roles` object[]: List of signer roles defined for the document.
      - `name` string: Name of the role, for example `Signer 1`.
      - `unique_id` string: ID of the role.
      - `signing_order` string: Position of the role in the signing order.
    - `seals` object[]: List of applied seal elements on the document.
    - `texts` object[]: List of text elements added to the document.
    - `checks` object[]: List of checkmark elements added to the document.
    - `fields` object[]: List of fillable fields defined on the document.
      - `id` string: ID of the field.
      - `role` string: Name of the role the field is assigned to.
      - `type` string: Field type, for example `text`, `signature`, or `checkbox`.
      - `role_id` string: ID of the role the field is assigned to.
      - `field_id` string: ID of the field.
      - `fulfiller` string: Email address of the recipient who filled in the field. `null` if not filled in.
      - `element_id` string: ID of the element that holds the field value. `null` if the field is empty.
      - `originator` string: Email address of the document owner.
      - `json_attributes` object: Position, size, and settings of the field. The set of keys depends on the field type.
        - `x` integer: Horizontal position of the field on the page, in pixels.
        - `y` integer: Vertical position of the field on the page, in pixels.
        - `name` string: Name of the field.
        - `width` integer: Width of the field, in pixels.
        - `height` integer: Height of the field, in pixels.
        - `required` boolean: `true` if the recipient must fill in the field.
        - `page_number` integer: Zero-based number of the page the field is on.
        - `allowed_types` string[]: For signature fields: the ways the recipient can add a signature, for example `type` or `draw`.
      - `field_request_id` string: ID of the field request. Use it to resend the invite with `PUT /fieldinvite/{field_request_id}/resend`.
      - `template_field_id` unknown
      - `field_request_canceled` unknown
    - `created` string: Unix timestamp when the document was created.
    - `inserts` object[]: List of text inserts added to the document.
    - `updated` string: Unix timestamp of the last document update.
    - `user_id` string: Unique identifier of the document owner.
    - `payments` object[]: List of payment requests attached to the document.
    - `requests` object[]: List of document requests.
    - `settings` object: Document-level settings and feature flags.
    - `template` boolean: Indicates whether the document is a template. `true` if it is a template, `false` otherwise.
    - `parent_id` string: Identifier of the parent document.
    - `thumbnail` object: Links to the document thumbnail images in `small`, `medium`, and `large` sizes.
      - `large` string: URL of the large thumbnail.
      - `small` string: URL of the small thumbnail.
      - `medium` string: URL of the medium thumbnail.
    - `hyperlinks` object[]: List of hyperlink elements on the document.
    - `owner_name` string: Display name of the document owner.
    - `page_count` string: Number of pages in the document, as a string.
    - `signatures` object[]: List of applied signature elements on the document.
      - `x` string: Horizontal position of the signature on the page, in pixels.
      - `y` string: Vertical position of the signature on the page, in pixels.
      - `id` string: ID of the signature.
      - `data` string: Image of the signature, Base64-encoded.
      - `email` string: Email address of the user who added the signature.
      - `width` string: Width of the signature, in pixels.
      - `height` string: Height of the signature, in pixels.
      - `created` string: Unix timestamp of when the signature was added.
      - `subtype` string: Subtype of the element, for example `signature` or `initials`.
      - `user_id` string: ID of the user who added the signature.
      - `page_number` string: Zero-based number of the page the signature is on.
      - `signature_request_id` unknown
    - `attachments` object[]: List of file attachments on the document.
    - `exported_to` object[]: List of destinations to which the document has been exported.
    - `integrations` object[]: List of third-party integrations associated with the document.
    - `radiobuttons` object[]: List of radio button groups on the document.
    - `version_time` string: Unix timestamp of the document version.
    - `viewer_roles` object[]: List of viewer roles defined for the document.
    - `document_name` string: Name of the document.
    - `field_invites` object[]: List of signer field invites for the document.
      - `id` string: ID of the field invite.
      - `role` string: Name of the recipient role.
      - `email` string: Email address of the signer. For an SMS invite, a generated placeholder address.
      - `pfrid` unknown
      - `status` string: Status of the invite, for example `pending`, `fulfilled`, or `declined`.
      - `created` string: Unix timestamp of when the invite was created.
      - `pfrtype` unknown
      - `role_id` string: ID of the recipient role.
      - `updated` string: Unix timestamp of the last update of the invite.
      - `declined` object[]: Decline details. Empty if the signer has not declined.
      - `reassign` string: `"1"` if the signer can reassign the invite, otherwise `"0"`.
      - `reminder` string: `"1"` if reminders are enabled for the invite, otherwise `"0"`.
      - `pframount` unknown
      - `pfrstatus` unknown
      - `pfrcreated` unknown
      - `id_verified` string: ID verification status of the signer, for example `UNVERIFIED`.
      - `is_embedded` boolean: `true` if the invite is an embedded invite.
      - `redirect_uri` unknown
      - `delivery_type` string: How the invite is delivered: `email` or `sms`.
      - `password_type` string: Type of the invite password. Empty if no password is set.
      - `email_statuses` object[]: Email delivery events of the invite. Each object is one event.
      - `pfrmerchant_id` unknown
      - `signer_user_id` string: ID of the signer user.
      - `embedded_signer` object[]: Embedded signer details. Empty if the invite is not embedded.
      - `expiration_time` string: Unix timestamp of when the invite expires.
      - `is_draft_exists` string: `"1"` if the signer has saved a draft, otherwise `"0"`.
      - `password_method` string: Method used to deliver the invite password. Empty if no password is set.
      - `payment_request` unknown
      - `is_full_declined` boolean: `true` if the recipient declined the invite.
      - `pfrcurrency_name` unknown
      - `pfrmerchant_type` unknown
      - `is_document_locked` string: `"1"` if the document is locked for this signer, otherwise `"0"`.
      - `password_protected` string: `"1"` if the invite is password-protected, otherwise `"0"`.
      - `pfrjson_attributes` unknown
      - `force_new_signature` unknown
      - `signer_phone_invite` unknown
      - `decline_by_signature` string: `"1"` if the signer can decline the invite, otherwise `"0"`. `null` if not set.
      - `signing_instructions` unknown
      - `electronic_consent_id` string: ID of the electronic consent the signer accepted. `null` if not accepted.
      - `prefill_signature_name` unknown
      - `id_verification_required` string: Whether ID verification is required, for example `NO`.
      - `pfrmerchant_account_name` unknown
      - `pfrpayment_transaction_id` unknown
      - `electronic_consent_required` integer: `1` if the signer must accept the electronic consent before signing, otherwise `0`.
      - `required_preset_signature_name` unknown
      - `stripe_ach_bank_account_present` string: `"1"` if a Stripe ACH bank account is connected for the payment request, otherwise `"0"`.
      - `stripe_ach_bank_account_verified` string: `"1"` if the Stripe ACH bank account is verified, otherwise `"0"`.
    - `notary_invites` object[]: List of notary invites on the document.
    - `origin_user_id` unknown
    - `originator_logo` string: URL reference to the document originator's logo.
    - `routing_details` object[]: Invite routing configuration, including signer order, `cc` recipients, and invite link instructions.
      - `cc` object[]: Email addresses that receive a copy of the completed document.
      - `id` string: ID of the routing details.
      - `data` object[]: Signer roles and their invite settings.
        - `name` string: Name of the role.
        - `role_id` string: ID of the role.
        - `inviter_role` boolean: `true` if the document owner is the recipient for this role.
        - `default_email` string: Default email address of the recipient for this role. Empty if not set.
        - `delivery_type` string: How the invite is delivered: `email` or `sms`.
        - `signing_order` integer: Position of the role in the signing order.
      - `cc_step` object[]: Steps after which CC recipients are notified.
      - `created` string: Unix timestamp of when the routing details were created.
      - `updated` string: Unix timestamp of the last update of the routing details.
      - `viewers` object[]: Viewer roles and their invite settings. Empty if there are no viewers.
      - `invite_link_instructions` unknown
    - `field_validators` object[]: List of field validation rules.
    - `original_filename` string: Original filename of the uploaded document.
    - `origin_document_id` unknown
    - `document_group_info` object: Document group information if this document belongs to a group.
      - `invite_id` unknown
      - `invite_status` unknown
      - `sign_as_merged` boolean: `true` if the documents in the group are signed as one merged document.
      - `document_group_id` unknown
      - `doc_count_in_group` integer: Number of documents in the document group. `0` if the document is not in a group.
      - `document_group_name` unknown
    - `enumeration_options` object[]: List of enumeration options for dropdown fields.
    - `viewer_field_invites` object[]: List of viewer field invites for the document.
    - `signing_session_settings` object: Settings applied to the signing session, such as `welcome_message`.
      - `welcome_message` unknown
    - `document_group_template_info` object[]: Active document group templates that include this document. Empty if the document isn't part of any document group template.
    - `originator_organization_settings` object[]: Organization-level settings that apply to the document's originator. Each item has a `setting` name and its `value`.
      - `value` string: Value of the setting, as a string.
      - `setting` string: Name of the setting.
  - `meta` object: Pagination details.
    - `pagination` object: Pagination details.
      - `count` integer: Number of items on the current page.
      - `links` object: Links to the adjacent pages. An empty array if there are no other pages.
        - `next` string: URL of the next page. Returned only if there is a next page.
        - `previous` string: URL of the previous page. Returned only if there is a previous page.
      - `total` integer: Total number of items.
      - `per_page` integer: Maximum number of items per page.
      - `total_pages` integer: Total number of pages.
      - `current_page` integer: Number of the current page.

## Other responses

- `403`: User is not the admin of the organization.
- `404`: Organization is not active or does not exist.

---

[API](https://skmtc.dev/signnow/apis/signnow-api.md) - [All operations](https://skmtc.dev/signnow/apis/signnow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signnow/apis/signnow-api/revisions/1c9c30a6142b?raw)