Skip to main content

List Recipients

Returns all recipients in a dock, ordered by createdAt descending.
GET /v1/docks/:dockId/recipients

Path Parameters

ParameterTypeDescription
dockIdstringThe dock ID

Example Request

curl https://api.docyard.io/v1/docks/dock_01HQ3K.../recipients \
  -H "Authorization: Bearer dk_live_a1b2c3d4..."

Response

[
  {
    "id": "rcp_01HQ3N...",
    "dockId": "dock_01HQ3K...",
    "name": "First National Bank",
    "email": "[email protected]",
    "stakeholderClass": "mortgagee",
    "identifiers": { "lender_id": "LND-4821" },
    "createdAt": "2025-01-15T10:32:00.000Z"
  },
  {
    "id": "rcp_01HQ3P...",
    "dockId": "dock_01HQ3K...",
    "name": "Jane Smith",
    "email": "[email protected]",
    "stakeholderClass": "policyholder",
    "identifiers": {},
    "createdAt": "2025-01-15T10:30:00.000Z"
  }
]

Error Handling

StatusCondition
401Missing or invalid API key
404Dock not found