---
title: "Get pending group invites"
method: GET
path: "/documentgroup/{document_group_id}/groupinvite/{invite_id}/pendinginvites"
---

# Get pending group invites

`GET /documentgroup/{document_group_id}/groupinvite/{invite_id}/pendinginvites`

## Request

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

This endpoint allows API users to retrieve all pending invites of a document group invite.
If the caller is the document owner, the response includes both pending invites for that user and all fulfilled actions for the entire group invite.


Possible invite actions are:
- `sign`: The recipient can sign or fill out the document.
- `approve`: The recipient can review the document to approve or decline it.
- `view`: The recipient can only review the document without making changes.

## Response `200`

Pending invites for the caller in the document group invite. If the caller is the document group owner, fulfilled actions of the whole invite are included.

- object
  - `invites` object[]: Pending invite actions.
    - `link` string: Link that opens the document in the signing session.
    - `action` string: Action the recipient is invited to perform: `sign`, `approve`, or `view`.
    - `status` string: Status of the invite action: `pending` or `fulfilled`.
    - `step_id` string: ID of the invite step the action belongs to.
    - `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.
    - `document_id` string: ID of the document in the group.
    - `access_token` string: Access token for the signing session of this document.
    - `redirect_uri` string: URL-encoded address the recipient is redirected to after the signing session.
    - `document_name` string: Name of the document.
    - `inviter_email` string: Email address of the user who sent the invite.
    - `payment_request` object: Payment request attached to the invite action. `null` if there is none.
  - `sign_as_merged` boolean: Whether the documents are signed as a single merged document.
  - `document_group_name` string: Name of the document group.
  - `owner_organization_id` string: ID of the organization of the document group owner.

## Other responses

- `400`: * Wrong, expired, or missing token. * The document group doesn't exist. * The group invite doesn't exist. * The group invite was canceled.

---

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