---
title: "Get doc group invite"
url: "https://docs.signnow.com/docs/doc-group-field-invite/operations/get-document-group-invite"
type: "endpoint"
section: "doc-group-field-invite"
slug: "doc-group-field-invite/operations/get-document-group-invite"
method: "GET"
path: "/documentgroup/{document_group_id}/groupinvite/{invite_id}"
operation_id: "get-document-group-invite"
authorization: "bearer"
---

# Get doc group invite

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

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.



## Authorization

bearer

## Path Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `document_group_id` | string | Yes | ID of the document group. |
| `invite_id` | string | Yes | ID of the document group invite. |

## Responses

### 200

Success

**Example** (`Success`)

```json
{
  "invite": {
    "id": "b1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "steps": [
      {
        "id": "abXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "order": 1,
        "status": "pending",
        "actions": [
          {
            "email": "signer1@email.com",
            "action": "sign",
            "status": "pending",
            "role_name": "Signer 1",
            "document_id": "ddXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "signer_phone_invite": null
          },
          {
            "action": "sign",
            "status": "pending",
            "role_name": "Signer 1",
            "document_id": "ddXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "email_group": {
              "id": "unique_id_of_the_group",
              "name": "group name"
            },
            "signer_phone_invite": null
          },
          {
            "email": "signer2@email.com",
            "action": "sign",
            "status": "pending",
            "role_name": "Signer 2",
            "document_id": "cdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "signer_phone_invite": null
          },
          {
            "email": null,
            "action": "sign",
            "status": "pending",
            "role_name": "Signer 2 (SMS)",
            "document_id": "cdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "signer_phone_invite": "+14075985199"
          }
        ]
      },
      {
        "id": "deXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "order": 2,
        "status": "created",
        "actions": [
          {
            "email": "signer3@email.com",
            "action": "sign",
            "status": "created",
            "role_name": "Signer 3",
            "document_id": "ddXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "signer_phone_invite": null
          },
          {
            "email": "signer4@email.com",
            "action": "sign",
            "status": "created",
            "role_name": "Signer 4",
            "document_id": "ddXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "signer_phone_invite": null
          }
        ]
      },
      {
        "id": "c1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "order": 3,
        "status": "created",
        "actions": [
          {
            "email": "signer5@email.com",
            "action": "sign",
            "status": "created",
            "role_name": "Signer 5",
            "document_id": "cdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "signer_phone_invite": null
          },
          {
            "email": "signer6@email.com",
            "action": "sign",
            "status": "created",
            "role_name": "Signer 6",
            "document_id": "cdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "signer_phone_invite": null
          }
        ]
      }
    ],
    "status": "pending"
  }
}
```

### 400

* Incorrect group invite id in the endpoint
* Incorrect group id in the endpoint

**Example** (`Example 1`)

```json
{
  "errors": [
    {
      "code": 65582,
      "message": "unable to find document group invite of f1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    }
  ]
}
```

**Example** (`Incorrect group id in the endpoint`)

```json
{
  "errors": [
    {
      "code": 65582,
      "message": "unable to find document group"
    }
  ]
}
```

**Example** (`Incorrect group invite id in the endpoint`)

```json
{
  "errors": [
    {
      "code": 65582,
      "message": "unable to find document group invite of f1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    }
  ]
}
```

## Code Examples

> Replace `$SIGNNOW_ACCESS_TOKEN` and any `{placeholder}` values before running.

### cURL

```bash
curl -X GET \
  "https://api.signnow.com/documentgroup/{document_group_id}/groupinvite/{invite_id}" \
  -H "Authorization: Bearer $SIGNNOW_ACCESS_TOKEN"
```

---
*Full reference: https://docs.signnow.com/docs/doc-group-field-invite/operations/get-document-group-invite*