Appearance
Get an intake link
GET /api/v1/intake-requests/{id}
With the answers, once submitted. Needs the read permission.
| Permission | read |
| MCP tool | get_intake_request |
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | — |
Responses
| Status | Meaning |
|---|---|
200 | The intake link. |
401 | No key, or a key that is unknown, expired or revoked, or whose creator is no longer an owner or admin. |
403 | The key lacks the permission, or it is an API key and the workspace isn't on Teams & Platform. |
404 | Not found in the key's workspace (a key works only in the workspace it was made in; get_workspace says which). |
429 | More than 120 calls a minute through this key, more than 2000 from one network address (for IPv6, its /56 block) across all keys, or a limit on sending reached: the key's daily sends, the plan's or a recipient's daily requests, or the workspace's waiting approvals. |
Errors share one shape, { "message": "…" }: see Errors and rate limits.
200 body
| Field | Type | Description |
|---|---|---|
id | string (uuid) | — |
title | string or null | — |
message | string or null | — |
status | open or submitted or voided or expired | — |
after | review or sign | — |
respondent | object | — |
respondent.name | string | — |
respondent.email | string | — |
document_ids | array of string (uuid) | — |
signing_request_id | string or null | — |
submitted_at | string (date-time) or null | — |
expires_at | string (date-time) or null | — |
created_at | string (date-time) or null | — |
answers | object or null | — |
Example
json
{
"id": "e7b2d4f6-8a1c-4e3b-9d5f-7a2c4e6b8d1f",
"title": "Your details for the NDA",
"message": null,
"status": "submitted",
"after": "review",
"respondent": {
"name": "Ada Lovelace",
"email": "ada@example.com"
},
"document_ids": [
"8a1f5c2e-3b4d-4e6f-9a7b-1c2d3e4f5a6b"
],
"signing_request_id": null,
"submitted_at": "2026-11-04T10:02:31.000Z",
"expires_at": "2026-11-17T16:20:00.000Z",
"created_at": "2026-11-03T16:20:00.000Z",
"answers": {
"client_name": "Acme Inc.",
"effective_date": "2026-11-03"
}
}Examples
bash
curl https://tryjustdocs.com/api/v1/intake-requests/e7b2d4f6-8a1c-4e3b-9d5f-7a2c4e6b8d1f \
-H "Authorization: Bearer $JUSTDOCS_API_KEY"js
const response = await fetch("https://tryjustdocs.com/api/v1/intake-requests/e7b2d4f6-8a1c-4e3b-9d5f-7a2c4e6b8d1f", {
headers: {
Authorization: `Bearer ${process.env.JUSTDOCS_API_KEY}`,
},
});
if (!response.ok) throw new Error((await response.json()).message);
const result = await response.json();python
import os
import requests
response = requests.get(
"https://tryjustdocs.com/api/v1/intake-requests/e7b2d4f6-8a1c-4e3b-9d5f-7a2c4e6b8d1f",
headers={"Authorization": f"Bearer {os.environ['JUSTDOCS_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
result = response.json()