---
title: "Get freeform invites"
method: GET
path: "/v2/documents/{document_id}/free-form-invites"
---

# Get freeform invites

`GET /v2/documents/{document_id}/free-form-invites`

## Request

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

This endpoint allows API users to retrieve the list of FreeForm invites for a document.

## Response `200`

Successful response. Returns the FreeForm invites of the document with their status. `data` is empty if no FreeForm invites were sent.

- object
  - `data` object[]: FreeForm invites sent for the document.
    - `id` string: ID of the FreeForm invite.
    - `email` string: Email address of the recipient.
    - `status` string: Status of the invite, for example `pending` or `fulfilled`.
    - `created` integer: Unix timestamp of when the invite was created.
  - `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

- `400`: * Wrong, expired, or missing token. * Document not found.

---

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