---
title: "Get doc group invite"
method: GET
path: "/documentgroup/{document_group_id}/groupinvite/{invite_id}"
---

# Get doc group invite

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

## Request

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

This endpoint returns document group invite information, including the status of each field invite, step and action.

Here is the list of possible invite, action and step statuses:
- `created`: invite, action, or step has been created but is not waiting to be signed.
- `pending`: emails have been sent out for this invite action or step and are waiting to be viewed or signed.
- `fulfilled`: the invite, action, or step has been completed by signing, viewing or approving.
- `correction`: the step recipient is modifying the invite. 
- `canceled`: the invite or step has been canceled by the recipient.

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

## Response `200`

Success

- object
  - `invite` object: The document group invite.
    - `id` string: ID of the document group invite.
    - `steps` object[]: Ordered list of invite steps in the document group invite.
      - `id` string: ID of the invite step.
      - `order` integer: Position of the step in the signing order, starting at `1`.
      - `status` string: Status of the step. One of `created`, `pending`, `fulfilled`, `correction`, or `canceled`.
      - `actions` object[]: Recipients and the actions assigned to them within this step.
        - `email` string: Email address of the recipient. `null` when the recipient is invited by SMS (see `signer_phone_invite`).
        - `action` string: Action assigned to the recipient. One of `sign`, `approve`, or `view`.
        - `status` string: Status of the action. One of `created`, `pending`, `fulfilled`, `correction`, or `canceled`.
        - `role_name` string: Name of the recipient's role in the document.
        - `document_id` string: ID of the document within the document group this action applies to.
        - `signer_phone_invite` string: Phone number of the recipient invited by SMS, in E.164 format (`+` followed by up to 13 digits). `null` when the recipient is invited by email. Use this value as `phone_invite_to_update` when calling [Update doc group invite](/docs/doc-group-field-invite/operations/update-document-group-invite).
    - `status` string: Status of the document group invite. One of `created`, `pending`, `fulfilled`, `correction`, or `canceled`.

## Other responses

- `400`: * Incorrect group invite id in the endpoint. * Incorrect group id in the endpoint.

---

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