---
title: "Get document groups"
method: GET
path: "/user/documentgroups"
---

# Get document groups

`GET /user/documentgroups`

## Request

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

This endpoint allows API users to get all document groups the user owns. 

Results are sorted by `last_updated` and paginated with the `limit` and `offset` query parameters.

## Response `200`

Document groups owned by the user.

- object
  - `document_groups` object[]: List of document groups.
    - `state` string: State of the document group, for example `created`, `pending`, or `completed`.
    - `group_id` string: ID of the document group.
    - `documents` object[]: Documents in the group.
      - `id` string: ID of the document.
      - `name` string: Name of the document.
      - `roles` string[]: Names of the signer roles in the document.
      - `settings` object: Document settings.
        - `advanced_signing_flow` boolean: Whether the advanced signing flow is enabled for the document.
      - `thumbnail` object: Thumbnail URLs of the first page of the document.
        - `large` string: URL of the large thumbnail.
        - `small` string: URL of the small thumbnail.
        - `medium` string: URL of the medium thumbnail.
      - `page_count` integer: Number of pages in the document.
      - `has_credit_card_number` boolean: Whether the document contains a credit card number field.
    - `folder_id` string: ID of the folder the document group is in. `null` if it is not in a folder.
    - `invite_id` string: ID of the group invite. `null` if no invite was sent.
    - `group_name` string: Name of the document group.
    - `is_embedded` boolean: Whether the group invite is an embedded invite.
    - `last_updated` string: Unix timestamp of the last update, as a string.
    - `invite_status` string: Status of the group invite, for example `pending` or `fulfilled`. `null` if no invite was sent.
    - `freeform_invite` object: Freeform invite sent for the document group.
      - `id` string: ID of the freeform invite. `null` if none was sent.
    - `has_guest_signer` boolean: Whether the group invite has a guest signer.
    - `is_full_declined` boolean: Whether a recipient declined the whole document group.
    - `has_signing_group` boolean: Whether the group invite is sent to a signing group.
  - `document_group_total_count` integer: Total number of document groups owned by the user.
  - `originator_organization_settings` object[]: Settings of the user's organization that apply to signing sessions.
    - `value` string: Value of the setting, as a string.
    - `setting` string: Name of the setting.

## Other responses

- `400`: * Wrong, expired, or missing token. * `limit` is missing or isn't between `1` and `50`. * `offset` is less than `0`.

---

[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)